Merge pull request #1295 from code-corps/1286-conversation-models

1286 conversation models

Author: joshsmith

lib/code_corps/model/conversation.ex

@@ -0,0 +1,29 @@
+defmodule CodeCorps.Conversation do
+  @moduledoc ~S"""
+  A header of a `CodeCorps.Message` thread, depicting a start of a conversation
+  with a specific `CodeCorps.User`
+
+  When a project sends a `CodeCorps.Message` to one or more users, a
+  `CodeCorps.Conversation` needs to be created for each of those users, so
+  separate conversations can be held with different users starting from the same
+  original `CodeCorps.Message`
+
+  Once replies start coming in, a `CodeCorps.ConversationPart` is created for
+  each of those replies.
+  """
+  use CodeCorps.Model
+
+  @type t :: %__MODULE__{}
+
+  schema "conversations" do
+    field :status, :string, null: false, default: "open"
+    field :read_at, :utc_datetime, null: true
+
+    belongs_to :message, CodeCorps.Message
+    belongs_to :user, CodeCorps.User
+
+    has_many :conversation_parts, CodeCorps.ConversationPart
+
+    timestamps()
+  end
+end

lib/code_corps/model/conversation_part.ex

@@ -0,0 +1,28 @@
+defmodule CodeCorps.ConversationPart do
+  @moduledoc ~S"""
+  An individual "line of conversation" in a `CodeCorps.Conversation` thread,
+  depicting a reply to the `CodeCorps.Conversation` by any of the two sides.
+
+  When a project sends a `CodeCorps.Message` to one or more users, a
+  `CodeCorps.Conversation` needs to be created for each of those users, so
+  separate conversations can be held with different users starting from the same
+  original `CodeCorps.Message`
+
+  Once replies start coming in, a `CodeCorps.ConversationPart` is created for
+  each of those replies, regardless of which side is making them.
+  """
+
+  use CodeCorps.Model
+
+  @type t :: %__MODULE__{}
+
+  schema "conversation_parts" do
+    field :body, :string, null: false
+    field :read_at, :utc_datetime, null: true
+
+    belongs_to :author, CodeCorps.User
+    belongs_to :conversation, CodeCorps.Conversation
+
+    timestamps()
+  end
+end

lib/code_corps/model/message.ex

@@ -25,6 +25,8 @@ defmodule CodeCorps.Message do
     belongs_to :author, CodeCorps.User
     belongs_to :project, CodeCorps.Project
 
+    has_many :conversations, CodeCorps.Conversation
+
     timestamps()
   end
 

priv/repo/migrations/20171213062707_add_conversation_models.exs

@@ -0,0 +1,30 @@
+defmodule CodeCorps.Repo.Migrations.AddConversationModels do
+  use Ecto.Migration
+
+  def change do
+    create table(:conversations) do
+      add :status, :string, null: false, default: "open"
+      add :read_at, :utc_datetime, null: true
+      add :message_id, references(:messages)
+      add :user_id, references(:users)
+
+      timestamps()
+    end
+
+    create index(:conversations, [:status])
+    create index(:conversations, [:message_id])
+    create index(:conversations, [:user_id])
+
+    create table(:conversation_parts) do
+      add :body, :text, null: false
+      add :read_at, :utc_datetime, null: true
+      add :author_id, references(:users)
+      add :conversation_id, references(:conversations)
+
+      timestamps()
+    end
+
+    create index(:conversation_parts, [:author_id])
+    create index(:conversation_parts, [:conversation_id])
+  end
+end

priv/repo/structure.sql

@@ -155,6 +155,74 @@ CREATE SEQUENCE comments_id_seq
 ALTER SEQUENCE comments_id_seq OWNED BY comments.id;
 
 
+--
+-- Name: conversation_parts; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE conversation_parts (
+    id bigint NOT NULL,
+    body text NOT NULL,
+    read_at timestamp without time zone,
+    author_id bigint,
+    conversation_id bigint,
+    inserted_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL
+);
+
+
+--
+-- Name: conversation_parts_id_seq; Type: SEQUENCE; Schema: public; Owner: -
+--
+
+CREATE SEQUENCE conversation_parts_id_seq
+    START WITH 1
+    INCREMENT BY 1
+    NO MINVALUE
+    NO MAXVALUE
+    CACHE 1;
+
+
+--
+-- Name: conversation_parts_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: -
+--
+
+ALTER SEQUENCE conversation_parts_id_seq OWNED BY conversation_parts.id;
+
+
+--
+-- Name: conversations; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE conversations (
+    id bigint NOT NULL,
+    status character varying(255) DEFAULT 'open'::character varying NOT NULL,
+    read_at timestamp without time zone,
+    message_id bigint,
+    user_id bigint,
+    inserted_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL
+);
+
+
+--
+-- Name: conversations_id_seq; Type: SEQUENCE; Schema: public; Owner: -
+--
+
+CREATE SEQUENCE conversations_id_seq
+    START WITH 1
+    INCREMENT BY 1
+    NO MINVALUE
+    NO MAXVALUE
+    CACHE 1;
+
+
+--
+-- Name: conversations_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: -
+--
+
+ALTER SEQUENCE conversations_id_seq OWNED BY conversations.id;
+
+
 --
 -- Name: donation_goals; Type: TABLE; Schema: public; Owner: -
 --
@@ -1826,6 +1894,20 @@ ALTER TABLE ONLY categories ALTER COLUMN id SET DEFAULT nextval('categories_id_s
 ALTER TABLE ONLY comments ALTER COLUMN id SET DEFAULT nextval('comments_id_seq'::regclass);
 
 
+--
+-- Name: conversation_parts id; Type: DEFAULT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY conversation_parts ALTER COLUMN id SET DEFAULT nextval('conversation_parts_id_seq'::regclass);
+
+
+--
+-- Name: conversations id; Type: DEFAULT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY conversations ALTER COLUMN id SET DEFAULT nextval('conversations_id_seq'::regclass);
+
+
 --
 -- Name: donation_goals id; Type: DEFAULT; Schema: public; Owner: -
 --
@@ -2144,6 +2226,22 @@ ALTER TABLE ONLY comments
     ADD CONSTRAINT comments_pkey PRIMARY KEY (id);
 
 
+--
+-- Name: conversation_parts conversation_parts_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY conversation_parts
+    ADD CONSTRAINT conversation_parts_pkey PRIMARY KEY (id);
+
+
+--
+-- Name: conversations conversations_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY conversations
+    ADD CONSTRAINT conversations_pkey PRIMARY KEY (id);
+
+
 --
 -- Name: donation_goals donation_goals_pkey; Type: CONSTRAINT; Schema: public; Owner: -
 --
@@ -2475,6 +2573,41 @@ CREATE INDEX comments_task_id_index ON comments USING btree (task_id);
 CREATE INDEX comments_user_id_index ON comments USING btree (user_id);
 
 
+--
+-- Name: conversation_parts_author_id_index; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX conversation_parts_author_id_index ON conversation_parts USING btree (author_id);
+
+
+--
+-- Name: conversation_parts_conversation_id_index; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX conversation_parts_conversation_id_index ON conversation_parts USING btree (conversation_id);
+
+
+--
+-- Name: conversations_message_id_index; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX conversations_message_id_index ON conversations USING btree (message_id);
+
+
+--
+-- Name: conversations_status_index; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX conversations_status_index ON conversations USING btree (status);
+
+
+--
+-- Name: conversations_user_id_index; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX conversations_user_id_index ON conversations USING btree (user_id);
+
+
 --
 -- Name: donation_goals_current_unique_to_project; Type: INDEX; Schema: public; Owner: -
 --
@@ -3445,6 +3578,38 @@ ALTER TABLE ONLY comments
     ADD CONSTRAINT comments_user_id_fkey FOREIGN KEY (user_id) REFERENCES users(id);
 
 
+--
+-- Name: conversation_parts conversation_parts_author_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY conversation_parts
+    ADD CONSTRAINT conversation_parts_author_id_fkey FOREIGN KEY (author_id) REFERENCES users(id);
+
+
+--
+-- Name: conversation_parts conversation_parts_conversation_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY conversation_parts
+    ADD CONSTRAINT conversation_parts_conversation_id_fkey FOREIGN KEY (conversation_id) REFERENCES conversations(id);
+
+
+--
+-- Name: conversations conversations_message_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY conversations
+    ADD CONSTRAINT conversations_message_id_fkey FOREIGN KEY (message_id) REFERENCES messages(id);
+
+
+--
+-- Name: conversations conversations_user_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY conversations
+    ADD CONSTRAINT conversations_user_id_fkey FOREIGN KEY (user_id) REFERENCES users(id);
+
+
 --
 -- Name: donation_goals donation_goals_project_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: -
 --
@@ -3993,5 +4158,5 @@ ALTER TABLE ONLY users
 -- PostgreSQL database dump complete
 --
 
-INSERT INTO "schema_migrations" (version) VALUES (20160723215749), (20160804000000), (20160804001111), (20160805132301), (20160805203929), (20160808143454), (20160809214736), (20160810124357), (20160815125009), (20160815143002), (20160816020347), (20160816034021), (20160817220118), (20160818000944), (20160818132546), (20160820113856), (20160820164905), (20160822002438), (20160822004056), (20160822011624), (20160822020401), (20160822044612), (20160830081224), (20160830224802), (20160911233738), (20160912002705), (20160912145957), (20160918003206), (20160928232404), (20161003185918), (20161019090945), (20161019110737), (20161020144622), (20161021131026), (20161031001615), (20161121005339), (20161121014050), (20161121043941), (20161121045709), (20161122015942), (20161123081114), (20161123150943), (20161124085742), (20161125200620), (20161126045705), (20161127054559), (20161205024856), (20161207112519), (20161209192504), (20161212005641), (20161214005935), (20161215052051), (20161216051447), (20161218005913), (20161219160401), (20161219163909), (20161220141753), (20161221085759), (20161226213600), (20161231063614), (20170102130055), (20170102181053), (20170104113708), (20170104212623), (20170104235423), (20170106013143), (20170115035159), (20170115230549), (20170121014100), (20170131234029), (20170201014901), (20170201025454), (20170201035458), (20170201183258), (20170220032224), (20170224233516), (20170226050552), (20170228085250), (20170308214128), (20170308220713), (20170308222552), (20170313130611), (20170318032449), (20170318082740), (20170324194827), (20170424215355), (20170501225441), (20170505224222), (20170526095401), (20170602000208), (20170622205732), (20170626231059), (20170628092119), (20170628213609), (20170629183404), (20170630140136), (20170706132431), (20170707213648), (20170711122252), (20170717092127), (20170725060612), (20170727052644), (20170731130121), (20170814131722), (20170913114958), (20170921014405), (20170925214512), (20170925230419), (20170926134646), (20170927100300), (20170928234412), (20171003134956), (20171003225853), (20171006063358), (20171006161407), (20171012215106), (20171012221231), (20171016125229), (20171016125516), (20171016223356), (20171016235656), (20171017235433), (20171019191035), (20171025184225), (20171026010933), (20171027061833), (20171028011642), (20171028173508), (20171030182857), (20171031232023), (20171031234356), (20171101023309), (20171104013543), (20171106045740), (20171106050209), (20171106103153), (20171106200036), (20171109231538), (20171110001134), (20171114010851), (20171114033357), (20171114225214), (20171114225713), (20171114232534), (20171115201624), (20171115225358), (20171119004204), (20171121075226), (20171121144138), (20171123065902), (20171127215847), (20171201073818), (20171205161052);
+INSERT INTO "schema_migrations" (version) VALUES (20160723215749), (20160804000000), (20160804001111), (20160805132301), (20160805203929), (20160808143454), (20160809214736), (20160810124357), (20160815125009), (20160815143002), (20160816020347), (20160816034021), (20160817220118), (20160818000944), (20160818132546), (20160820113856), (20160820164905), (20160822002438), (20160822004056), (20160822011624), (20160822020401), (20160822044612), (20160830081224), (20160830224802), (20160911233738), (20160912002705), (20160912145957), (20160918003206), (20160928232404), (20161003185918), (20161019090945), (20161019110737), (20161020144622), (20161021131026), (20161031001615), (20161121005339), (20161121014050), (20161121043941), (20161121045709), (20161122015942), (20161123081114), (20161123150943), (20161124085742), (20161125200620), (20161126045705), (20161127054559), (20161205024856), (20161207112519), (20161209192504), (20161212005641), (20161214005935), (20161215052051), (20161216051447), (20161218005913), (20161219160401), (20161219163909), (20161220141753), (20161221085759), (20161226213600), (20161231063614), (20170102130055), (20170102181053), (20170104113708), (20170104212623), (20170104235423), (20170106013143), (20170115035159), (20170115230549), (20170121014100), (20170131234029), (20170201014901), (20170201025454), (20170201035458), (20170201183258), (20170220032224), (20170224233516), (20170226050552), (20170228085250), (20170308214128), (20170308220713), (20170308222552), (20170313130611), (20170318032449), (20170318082740), (20170324194827), (20170424215355), (20170501225441), (20170505224222), (20170526095401), (20170602000208), (20170622205732), (20170626231059), (20170628092119), (20170628213609), (20170629183404), (20170630140136), (20170706132431), (20170707213648), (20170711122252), (20170717092127), (20170725060612), (20170727052644), (20170731130121), (20170814131722), (20170913114958), (20170921014405), (20170925214512), (20170925230419), (20170926134646), (20170927100300), (20170928234412), (20171003134956), (20171003225853), (20171006063358), (20171006161407), (20171012215106), (20171012221231), (20171016125229), (20171016125516), (20171016223356), (20171016235656), (20171017235433), (20171019191035), (20171025184225), (20171026010933), (20171027061833), (20171028011642), (20171028173508), (20171030182857), (20171031232023), (20171031234356), (20171101023309), (20171104013543), (20171106045740), (20171106050209), (20171106103153), (20171106200036), (20171109231538), (20171110001134), (20171114010851), (20171114033357), (20171114225214), (20171114225713), (20171114232534), (20171115201624), (20171115225358), (20171119004204), (20171121075226), (20171121144138), (20171123065902), (20171127215847), (20171201073818), (20171205161052), (20171213062707);
 

test/support/factories.ex

@@ -23,6 +23,24 @@ defmodule CodeCorps.Factories do
     }
   end
 
+  def conversation_factory do
+    %CodeCorps.Conversation{
+      status: "open",
+      read_at: nil,
+      message: build(:message),
+      user: build(:user)
+    }
+  end
+
+  def conversation_part_factory do
+    %CodeCorps.ConversationPart{
+      body: sequence(:body, &"Reply to conversation #{&1}"),
+      read_at: nil,
+      author: build(:user),
+      conversation: build(:conversation)
+    }
+  end
+
   def donation_goal_factory do
     %CodeCorps.DonationGoal{
       amount: 100,