Merge pull request #722 from code-corps/711-add-project-users

Add ProjectUsers infrastructure

Author: joshsmith

lib/code_corps/analytics/segment_event_name_builder.ex

@@ -20,6 +20,12 @@ defmodule CodeCorps.Analytics.SegmentEventNameBuilder do
   defp get_event_name(:update, %CodeCorps.OrganizationMembership{}) do
     "Approved Organization Membership"
   end
+  defp get_event_name(:create, %CodeCorps.ProjectUser{}) do
+    "Requested Project Membership"
+  end
+  defp get_event_name(:update, %CodeCorps.ProjectUser{}) do
+    "Approved Project Membership"
+  end
   defp get_event_name(:payment_succeeded, %CodeCorps.StripeInvoice{}) do
     "Processed Subscription Payment"
   end

lib/code_corps/analytics/segment_tracking_support.ex

@@ -13,6 +13,8 @@ defmodule CodeCorps.Analytics.SegmentTrackingSupport do
   def includes?(:update, %CodeCorps.DonationGoal{}), do: true
   def includes?(:create, %CodeCorps.OrganizationMembership{}), do: true
   def includes?(:update, %CodeCorps.OrganizationMembership{}), do: true
+  def includes?(:create, %CodeCorps.ProjectUser{}), do: true
+  def includes?(:update, %CodeCorps.ProjectUser{}), do: true
   def includes?(:create, %CodeCorps.StripeConnectAccount{}), do: true
   def includes?(:create, %CodeCorps.StripeConnectCharge{}), do: true
   def includes?(:create, %CodeCorps.StripeConnectPlan{}), do: true

lib/code_corps/analytics/segment_traits_builder.ex

@@ -38,6 +38,14 @@ defmodule CodeCorps.Analytics.SegmentTraitsBuilder do
     }
   end
 
+  defp traits(record = %CodeCorps.ProjectUser{}) do
+    record = record |> CodeCorps.Repo.preload(:project)
+    %{
+      project: record.project.title,
+      project_id: record.project_id
+    }
+  end
+
   defp traits(charge = %CodeCorps.StripeConnectCharge{}) do
     # NOTE: this only works for some currencies
     revenue = charge.amount / 100

lib/code_corps/helpers/policy.ex

@@ -8,7 +8,7 @@ defmodule CodeCorps.Helpers.Policy do
 
   alias CodeCorps.{
     Organization, OrganizationMembership,
-    Project, Repo, StripeConnectAccount,
+    Project, ProjectUser, Repo, StripeConnectAccount,
     TaskSkill, Task, User, UserTask
   }
   alias Ecto.Changeset
@@ -46,9 +46,10 @@ defmodule CodeCorps.Helpers.Policy do
 
   Returns `:string`
   """
-  @spec get_role(nil | OrganizationMembership.t | Changeset.t) :: String.t | nil
+  @spec get_role(nil | OrganizationMembership.t | ProjectUser.t | Changeset.t) :: String.t | nil
   def get_role(nil), do: nil
   def get_role(%OrganizationMembership{role: role}), do: role
+  def get_role(%ProjectUser{role: role}), do: role
   def get_role(%Changeset{} = changeset), do: changeset |> Changeset.get_field(:role)
 
   @doc """

priv/repo/migrations/20170228085250_create_project_users.exs

@@ -0,0 +1,15 @@
+defmodule CodeCorps.Repo.Migrations.CreateProjectUsers do
+  use Ecto.Migration
+
+  def change do
+    create table(:project_users) do
+      add :role, :string, null: false
+      add :project_id, references(:projects, on_delete: :nothing), null: false
+      add :user_id, references(:users, on_delete: :nothing), null: false
+
+      timestamps()
+    end
+
+    create index :project_users, [:user_id, :project_id], unique: true
+  end
+end

priv/repo/structure.sql

@@ -2,8 +2,8 @@
 -- PostgreSQL database dump
 --
 
--- Dumped from database version 9.5.4
--- Dumped by pg_dump version 9.5.4
+-- Dumped from database version 9.5.1
+-- Dumped by pg_dump version 9.5.1
 
 SET statement_timeout = 0;
 SET lock_timeout = 0;
@@ -318,6 +318,39 @@ CREATE SEQUENCE project_skills_id_seq
 ALTER SEQUENCE project_skills_id_seq OWNED BY project_skills.id;
 
 
+--
+-- Name: project_users; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE project_users (
+    id integer NOT NULL,
+    role character varying(255) NOT NULL,
+    project_id integer NOT NULL,
+    user_id integer NOT NULL,
+    inserted_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL
+);
+
+
+--
+-- Name: project_users_id_seq; Type: SEQUENCE; Schema: public; Owner: -
+--
+
+CREATE SEQUENCE project_users_id_seq
+    START WITH 1
+    INCREMENT BY 1
+    NO MINVALUE
+    NO MAXVALUE
+    CACHE 1;
+
+
+--
+-- Name: project_users_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: -
+--
+
+ALTER SEQUENCE project_users_id_seq OWNED BY project_users.id;
+
+
 --
 -- Name: projects; Type: TABLE; Schema: public; Owner: -
 --
@@ -1364,6 +1397,13 @@ ALTER TABLE ONLY project_categories ALTER COLUMN id SET DEFAULT nextval('project
 ALTER TABLE ONLY project_skills ALTER COLUMN id SET DEFAULT nextval('project_skills_id_seq'::regclass);
 
 
+--
+-- Name: id; Type: DEFAULT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY project_users ALTER COLUMN id SET DEFAULT nextval('project_users_id_seq'::regclass);
+
+
 --
 -- Name: id; Type: DEFAULT; Schema: public; Owner: -
 --
@@ -1603,6 +1643,14 @@ ALTER TABLE ONLY project_skills
     ADD CONSTRAINT project_skills_pkey PRIMARY KEY (id);
 
 
+--
+-- Name: project_users_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY project_users
+    ADD CONSTRAINT project_users_pkey PRIMARY KEY (id);
+
+
 --
 -- Name: projects_pkey; Type: CONSTRAINT; Schema: public; Owner: -
 --
@@ -1875,6 +1923,13 @@ CREATE UNIQUE INDEX project_skills_project_id_skill_id_index ON project_skills U
 CREATE INDEX project_skills_skill_id_index ON project_skills USING btree (skill_id);
 
 
+--
+-- Name: project_users_user_id_project_id_index; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE UNIQUE INDEX project_users_user_id_project_id_index ON project_users USING btree (user_id, project_id);
+
+
 --
 -- Name: projects_approved_index; Type: INDEX; Schema: public; Owner: -
 --
@@ -2229,6 +2284,22 @@ ALTER TABLE ONLY project_skills
     ADD CONSTRAINT project_skills_skill_id_fkey FOREIGN KEY (skill_id) REFERENCES skills(id);
 
 
+--
+-- Name: project_users_project_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY project_users
+    ADD CONSTRAINT project_users_project_id_fkey FOREIGN KEY (project_id) REFERENCES projects(id);
+
+
+--
+-- Name: project_users_user_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY project_users
+    ADD CONSTRAINT project_users_user_id_fkey FOREIGN KEY (user_id) REFERENCES users(id);
+
+
 --
 -- Name: projects_organization_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: -
 --
@@ -2537,5 +2608,5 @@ ALTER TABLE ONLY user_tasks
 -- 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);
+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);
 

test/controllers/project_user_controller_test.exs

@@ -0,0 +1,136 @@
+defmodule CodeCorps.ProjectUserControllerTest do
+  use CodeCorps.ApiCase, resource_name: :project_user
+
+  @attrs %{role: "contributor"}
+
+  describe "index" do
+    test "lists all resources", %{conn: conn} do
+      [record_1, record_2] = insert_pair(:project_user)
+
+      conn
+      |> request_index
+      |> json_response(200)
+      |> assert_ids_from_response([record_1.id, record_2.id])
+    end
+
+    test "filters resources by record id", %{conn: conn} do
+      [record_1, record_2 | _] = insert_list(3, :project_user)
+
+      path = "project-users/?filter[id]=#{record_1.id},#{record_2.id}"
+
+      conn
+      |> get(path)
+      |> json_response(200)
+      |> assert_ids_from_response([record_1.id, record_2.id])
+    end
+  end
+
+  describe "show" do
+    test "shows chosen resource", %{conn: conn} do
+      record = insert(:project_user)
+      conn
+      |> request_show(record)
+      |> json_response(200)
+      |> Map.get("data")
+      |> assert_result_id(record.id)
+    end
+
+    test "renders 404 when id is nonexistent", %{conn: conn} do
+      assert conn |> request_show(:not_found) |> json_response(404)
+    end
+  end
+
+  describe "create" do
+    @tag :authenticated
+    test "creates and renders resource when data is valid", %{conn: conn, current_user: user} do
+      project = insert(:project)
+      attrs = @attrs |> Map.merge(%{project: project, user: user})
+
+      assert conn |> request_create(attrs) |> json_response(201)
+
+      user_id = user.id
+      tracking_properties = %{
+        project: project.title,
+        project_id: project.id
+      }
+
+      assert_received {:track, ^user_id, "Requested Project Membership", ^tracking_properties}
+    end
+
+    @tag :authenticated
+    test "does not create resource and renders 422 when data is invalid", %{conn: conn, current_user: user} do
+      # only way to trigger a validation error is to provide a non-existant organization
+      # anything else will fail on authorization level
+      project = build(:project)
+      attrs = @attrs |> Map.merge(%{project: project, user: user})
+      assert conn |> request_create(attrs) |> json_response(422)
+    end
+
+    test "does not create resource and renders 401 when not authenticated", %{conn: conn} do
+      assert conn |> request_create |> json_response(401)
+    end
+
+    @tag :authenticated
+    test "does not create resource and renders 403 when not authorized", %{conn: conn} do
+      assert conn |> request_create |> json_response(403)
+    end
+  end
+
+  describe "update" do
+    @tag :authenticated
+    test "updates and renders resource when data is valid", %{conn: conn, current_user: current_user} do
+      project = insert(:project)
+      record = insert(:project_user, project: project, role: "pending")
+      insert(:project_user, project: project, user: current_user, role: "owner")
+
+      assert conn |> request_update(record, @attrs) |> json_response(200)
+
+      user_id = current_user.id
+      tracking_properties = %{
+        project: project.title,
+        project_id: project.id
+      }
+
+      assert_received {:track, ^user_id, "Approved Project Membership", ^tracking_properties}
+    end
+
+    test "doesn't update and renders 401 when unauthenticated", %{conn: conn} do
+      assert conn |> request_update |> json_response(401)
+    end
+
+    @tag :authenticated
+    test "doesn't update and renders 403 when not authorized", %{conn: conn} do
+      assert conn |> request_update |> json_response(403)
+    end
+
+    @tag :authenticated
+    test "renders 404 when id is nonexistent on update", %{conn: conn} do
+      assert conn |> request_update(:not_found) |> json_response(404)
+    end
+  end
+
+  describe "delete" do
+    @tag :authenticated
+    test "deletes resource", %{conn: conn, current_user: current_user} do
+      project = insert(:project)
+      record = insert(:project_user, project: project)
+      insert(:project_user, project: project, user: current_user, role: "owner")
+
+      assert conn |> request_delete(record) |> response(204)
+    end
+
+    test "renders 401 when unauthenticated", %{conn: conn} do
+      assert conn |> request_delete |> json_response(401)
+    end
+
+    @tag :authenticated
+    test "renders 403 when not authorized", %{conn: conn} do
+      assert conn |> request_delete |> json_response(403)
+    end
+
+    @tag :authenticated
+    test "renders 404 when id is nonexistent on delete", %{conn: conn} do
+      assert conn |> request_delete(:not_found) |> json_response(404)
+    end
+  end
+end

test/lib/code_corps/analytics/segment_event_name_builder_test.exs

@@ -18,6 +18,11 @@ defmodule CodeCorps.Analytics.SegmentEventNameBuilderTest do
       assert SegmentEventNameBuilder.build(:update, build(:organization_membership)) == "Approved Organization Membership"
     end
 
+    test "with project_user" do
+      assert SegmentEventNameBuilder.build(:create, build(:project_user)) == "Requested Project Membership"
+      assert SegmentEventNameBuilder.build(:update, build(:project_user)) == "Approved Project Membership"
+    end
+
     test "with task" do
       assert SegmentEventNameBuilder.build(:create, build(:task)) == "Created Task"
       assert SegmentEventNameBuilder.build(:update, build(:task)) == "Edited Task"