Design and basic implementation of the model.

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,5 +1,8 @@
-# Short Form
+# ShortForm
 
-The Short Form (`shortform`) project is a web application designed for 
+The ShortForm (`shortform`) project is a web application designed for 
 presenting and facilitating discussion for essays, articles, or general user to 
 user interactions.
+
+- [ADRs](./adr): Read about the ShortForm design.
+- [License](./LICENSE): Apache 2.0

adr/2023-11-26-shortform-data-model.md

@@ -0,0 +1,129 @@
+# ADR 2023-11-26: ShortForm Data Model
+
+## Table of Contents
+
+- [Context](#context)
+- [Decision](#decision)
+- [Relational Data Model](#relational-data-model)
+    - [Table: `content`](#table-content)
+    - [Table: `comments`](#table-comments)
+    - [Table: `assets`](#table-assets)
+    - [Table: `tags`](#table-tags)
+    - [Table: `content_tags`](#table-content_tags)
+    - [Table: `asset_tags`](#table-asset_tags)
+- [Disk Data Model](#disk-data-model)
+
+## Context
+
+ShortForm is a project intended to help facilitate discussion of interesting 
+topics among groups of people. Some person posts a prompt, essay, article, or
+some other piece of content and others engage in discussion. While most content
+is textual, ShortForm supports some set of static assets as well. Note that
+ShortForm only allows assets to be uploaded and presented by approved posters.
+Comments may only include text.
+
+## Decision
+
+- Adopt a relational data model that references content stored in some static 
+  file storage mechanism such as a local disk or S3.
+- Support comments.
+- ShortForm must support multiple backing storage mechanisms.
+- Support arbitrary file upload and download.
+
+## Relational Data Model
+
+- [Table: `content`](#table-content)
+- [Table: `comments`](#table-comments)
+- [Table: `assets`](#table-assets)
+- [Table: `tags`](#table-tags)
+- [Table: `content_tags`](#table-content_tags)
+- [Table: `asset_tags`](#table-asset_tags)
+
+### Table: `content`
+
+```sql
+CREATE TABLE content(
+    id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+    external_id UUID NOT NULL UNIQUE,
+    created_at TIMESTAMPTZ NOT NULL,
+    created_by BIGINT NOT NULL,
+    title TEXT NOT NULL,
+    hash TEXT NOT NULL
+);
+```
+
+### Table: `comments`
+
+```sql
+CREATE TABLE comments(
+    id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+    external_id UUID NOT NULL UNIQUE,
+    created_at TIMESTAMPTZ NOT NULL,
+    created_by BIGINT NOT NULL,
+    content TEXT NOT NULL,
+    parent BIGINT NULL,
+);
+```
+
+Comments store their content directly. Comments are not complex, and are 
+typically shorter than primary content. The practical limit for PostgreSQL is
+1gb per row, but ShortForm imposes a configurable limit (10kb by default).
+
+### Table: `assets`
+
+```sql
+CREATE TABLE assets(
+    id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+    external_id UUID NOT NULL UNIQUE,
+    created_at TIMESTAMPTZ NOT NULL,
+    created_by BIGINT NOT NULL,
+    mime TEXT NOT NULL,
+    title TEXT NOT NULL,
+    extension TEXT NOT NULL,
+    hash TEXT NOT NULL
+);
+```
+
+### Table: `tags`
+
+```sql
+CREATE TABLE tags(
+    id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+    value TEXT NOT NULL UNIQUE
+);
+```
+
+Tags are arbitrary labels that authors may assign to top level posts and assets.
+
+### Table: `content_tags`
+
+```sql
+CREATE TABLE content_tags(
+    content_id BIGINT NOT NULL,
+    tag_id BIGINT NOT NULL,
+    PRIMARY KEY(content_id, tag_id)
+);
+```
+
+### Table: `asset_tags`
+
+```sql
+CREATE TABLE asset_tags(
+    asset_id BIGINT NOT NULL,
+    tag_id BIGINT NOT NULL,
+    PRIMARY KEY(asset_id, tag_id)
+)
+```
+
+## Disk Data Model
+
+- The directory structure (path structure) is based on year, month, day.
+- Within each day, one file exists per piece of content created on that day.
+
+**Example**:
+
+```
+/2023/11/26/0e61ae14cc1f444cb5cbe48f0c301193.md
+/2023/11/26/0e61ae14cc1f444cb5cbe48f0c301193.html
+/2023/11/26/99ebf96760ba498798652ee4140a9f3e.png
+```

adr/2023-11-27-shortform-user-model.md

@@ -0,0 +1,74 @@
+# ADR 2023-11-27: ShortForm User Model
+
+## Table of Contents
+
+- [Context](#context)
+- [Decision](#decision)
+
+## Context
+
+ShortForm is a project intended to help facilitate discussion of interesting 
+topics among groups of people. Some person posts a prompt, essay, article, or
+some other piece of content and others engage in discussion.
+
+This application depends on the concept of a _user_. ShortForm has users who are
+allowed to post articles and upload assets, as well as the more-numerous user
+category which is allowed to post comments on content. Comments are the primary
+discussion forum of ShortForm.
+
+## Decision
+
+Keep scope tight for the initial build of ShortForm.
+
+- Support two types of users: posters and commenters.
+- Do not support registration - administrators in control of the server must add
+  users by hand.
+- Users have a username and a password.
+- New accounts cannot be used until users supply a password.
+- New accounts receive their initial password via the password reset mechanism.
+- The password reset mechanism for an account must be initiated by an admin.
+- Manage user accounts in the ShortForm database.
+- Use Argon2 for password encryption.
+
+These restrictions allow ShortForm to work as intended while remaining light on
+features initially, serving a small community that communicates directly outside
+of ShortForm.
+
+## Relational Data Model
+
+### Enum Type: `user_role`
+
+```sql
+CREATE TYPE user_role AS ENUM ('poster', 'commenter');
+```
+
+### Enum Type: `user_status`
+
+```sql
+CREATE TYPE user_status AS ENUM ('active', 'locked', 'initializing');
+```
+
+### Table: `users`
+
+```sql
+CREATE TABLE users(
+    id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+    created_at TIMESTAMPTZ NOT NULL,
+    username TEXT NOT NULL UNIQUE,
+    password TEXT NOT NULL,
+    role user_role NOT NULL,
+    status user_status NOT NULL
+);
+```
+
+### Table: `password_resets`
+
+```sql
+CREATE TABLE password_resets(
+    id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+    created_at TIMESTAMPTZ NOT NULL,
+    expires_at TIMESTAMPTZ NOT NULL,
+    token TEXT NOT NULL,
+    used BOOLEAN NOT NULL
+);
+```

adr/README.md

@@ -0,0 +1,4 @@
+# Architecture Decision Records (ADRs)
+
+- [2023-11-26: ShortForm Data Model](./2023-11-26-shortform-data-model.md)
+- [2023-11-27: ShortForm User Model](./2023-11-27-shortform-user-model.md)

build.sbt

@@ -102,7 +102,7 @@ lazy val shortform = (project in file("."))
     crypto,
     model,
     db,
-    api
+    app
    )
   .settings(sharedSettings)
   .settings(name := "shortform")
@@ -181,11 +181,11 @@ lazy val `db-integration-tests` = project
     )
   )
 
-lazy val api = project
-  .in(file("modules/api"))
+lazy val app = project
+  .in(file("modules/app"))
   .enablePlugins(JavaServerAppPackaging)
   .dependsOn(uuid, error, crypto, model, db)
-  .settings(name := s"$ProjectName-api")
+  .settings(name := s"$ProjectName-app")
   .settings(sharedSettings)
   .settings(testSettings)
   .settings(

modules/model/src/main/scala/gs/shortform/model/Content.scala

@@ -0,0 +1,25 @@
+package gs.shortform.model
+
+import gs.uuid.UUID
+import gs.shortform.crypto.Hash
+
+/**
+  * Represents a top level piece of content - an article, essay, prompt, or some
+  * other written piece of work. All content must have a [[Title]] for display
+  * purposes.
+  *
+  * Content cannot currently be edited.
+  *
+  * @param externalId Globally unique identifier for this content.
+  * @param createdAt Instant this content was created.
+  * @param createdBy User who created this content.
+  * @param title Display title for this content.
+  * @param hash Hash of the primary rendered file for this content.
+  */
+case class Content(
+  externalId: UUID,
+  createdAt: CreatedAt,
+  createdBy: CreatedBy,
+  title: Title, 
+  hash: Hash
+)

modules/model/src/main/scala/gs/shortform/model/CreatedAt.scala

@@ -0,0 +1,26 @@
+package gs.shortform.model
+
+import java.time.Instant
+import java.time.OffsetDateTime
+import java.time.ZoneOffset
+
+/**
+  * Represents the instant some resource was created.
+  */
+opaque type CreatedAt = Instant
+
+object CreatedAt:
+
+  def apply(value: Instant): CreatedAt = value
+
+  def fromOffsetDateTime(value: OffsetDateTime): CreatedAt = value.toInstant()
+
+  given CanEqual[CreatedAt, CreatedAt] = CanEqual.derived
+
+  extension (createdAt: CreatedAt)
+    def toInstant(): Instant = createdAt
+
+    def toOffsetDateTime(): OffsetDateTime = 
+      toInstant().atOffset(ZoneOffset.UTC)
+
+end CreatedAt

modules/model/src/main/scala/gs/shortform/model/CreatedBy.scala

@@ -0,0 +1,18 @@
+package gs.shortform.model
+
+/**
+  * Username of the user who created some resource.
+  */
+opaque type CreatedBy = String
+
+object CreatedBy:
+
+  // TODO: Create from username.
+  def apply(value: String): CreatedBy = value
+
+  given CanEqual[CreatedBy, CreatedBy] = CanEqual.derived
+
+  extension (createdBy: CreatedBy)
+    def str(): String = createdBy
+
+end CreatedBy

modules/model/src/main/scala/gs/shortform/model/Title.scala

@@ -0,0 +1,18 @@
+package gs.shortform.model
+
+/**
+  * The descriptive title for some resource.
+  */
+opaque type Title = String
+
+object Title:
+
+  def apply(value: String): Title = value
+
+  given CanEqual[Title, Title] = CanEqual.derived
+
+  extension (title: Title)
+    def str(): String = title
+
+end Title
+