feat: add helpers to users and organization models

Author: stakach

shard.lock

@@ -54,7 +54,7 @@ shards:
 
   multi_auth:
     git: https://github.com/spider-gazelle/multi_auth.git
-    version: 1.2.0+git.commit.5fa8730425f04bea6eeae47fa99e38b9522265c2
+    version: 1.2.0+git.commit.8cb43fb8064d7a0d2a6198e584b4d9b8a9ef4901
 
   mysql:
     git: https://github.com/crystal-lang/crystal-mysql.git
@@ -66,7 +66,7 @@ shards:
 
   pg-orm:
     git: https://github.com/spider-gazelle/pg-orm.git
-    version: 2.0.1
+    version: 2.0.3
 
   pool:
     git: https://github.com/ysbaddaden/pool.git

spec/models/org_user_spec.cr

@@ -1,32 +1,76 @@
 require "../spec_helper"
 
-describe App::Models::OrganizationUser do
-  org_user = App::Models::OrganizationUser.new
-  org = App::Models::Organization.new
-  user = App::Models::User.new
-
-  Spec.around_each do |test|
-    org_user = App::Models::OrganizationUser.new
-    org = App::Models::Organization.new
-    org.name = "Testing"
-    org.save!
-
-    user = App::Models::User.new
-    user.name = "Testing"
-    user.email = "steve@orguser.com"
-    user.save!
-
-    test.run
-
-    org_user.destroy
-    org.destroy
-    user.destroy
-  end
+module App::Models
+  describe OrganizationUser do
+    org = Organization.new
+    user = User.new
+
+    Spec.around_each do |test|
+      org = Organization.new(name: "Testing").save!
+      user = User.new(name: "Testing", email: "steve@orguser.com").save!
+
+      test.run
+
+      org.destroy
+      user.destroy
+    end
+
+    it "should be able to associate a user with an organisation" do
+      org.add user
+      org.users.to_a.map(&.id).first?.should eq user.id
+      user.organizations.first.id.should eq org.id
+    end
+
+    it "should be able to associate multiple users with an organisation" do
+      user2 = User.new(name: "User2", email: "user2@org.com").save!
+      user3 = User.new(name: "User3", email: "user3@org.com").save!
+
+      org.add user
+      org.add user2
+
+      org.users.map(&.id).to_set.should eq [user.id, user2.id].to_set
+      user3.organizations.to_a.should be_empty
+
+      user2.destroy
+      user3.destroy
+      # we've left the original user
+      OrganizationUser.all.count.should eq 1
+    end
+
+    it "should be able to associate multiple organisations with a user" do
+      org2 = Organization.new(name: "org2").save!
+      org3 = Organization.new(name: "org3").save!
+
+      org.add user
+      org2.add user
+
+      user.organizations.map(&.id).to_set.should eq [org.id, org2.id].to_set
+      org3.users.to_a.should be_empty
+
+      org2.destroy
+      org3.destroy
+      # we've left the original org
+      OrganizationUser.all.count.should eq 1
+    end
+
+    it "use helper functions to manage users" do
+      user2 = User.new(name: "User2", email: "user2@org.com").save!
+      user3 = User.new(name: "User3", email: "user3@org.com").save!
+
+      org.add user
+      org.add user2
+      org.add user3
+      org.users.map(&.id).to_set.should eq [user.id, user2.id, user3.id].to_set
+
+      org.remove user
+      org.remove user2
+      org.users.count.should eq 1
+      org.remove user3
+      org.users.count.should eq 0
+      OrganizationUser.all.count.should eq 0
 
-  it "should be able to associate a user with an organisation" do
-    org_user.user = user
-    org_user.organization = org
-    org_user.permission = App::Permissions::Admin
-    org_user.save!
+      user2.destroy
+      user3.destroy
+    end
   end
 end

src/models/organization.cr

@@ -8,5 +8,39 @@ class App::Models::Organization < ::PgORM::Base
   attribute owner_id : UUID?
   belongs_to :owner, class_name: User
 
+  def users
+    User.join(:inner, OrganizationUser, :user_id).where("organization_users.organization_id = ?", self.id)
+  end
+
+  def remove(user : User)
+    OrganizationUser.find!({user.id, self.id}).destroy
+  end
+
+  def add(user : User, permission : App::Permissions = App::Permissions::User)
+    OrganizationUser.new(
+      user_id: user.id,
+      organization_id: self.id,
+      permission: permission
+    ).save!
+  end
+
+  def invite(user : User, permission : App::Permissions = App::Permissions::User, expires : Time? = nil)
+    OrganizationInvite.new(
+      email: user.email,
+      organization_id: self.id,
+      permission: permission,
+      expires: expires
+    ).save!
+  end
+
+  def invite(email : String, permission : App::Permissions = App::Permissions::User, expires : Time? = nil)
+    OrganizationInvite.new(
+      email: email,
+      organization_id: self.id,
+      permission: permission,
+      expires: expires
+    ).save!
+  end
+
   include PgORM::Timestamps
 end

src/models/organization_invite.cr

@@ -9,6 +9,7 @@ class App::Models::OrganizationInvite < ::PgORM::Base
   default_primary_key id : UUID
 
   # TODO:: email validation
+  # TODO:: additionally add user_id invites
   attribute email : String
   attribute secret : String, mass_assignment: false
 
@@ -20,4 +21,14 @@ class App::Models::OrganizationInvite < ::PgORM::Base
 
   # generate a secret for this invite
   before_create { self.secret = UUID.random.to_s }
+
+  def accept!
+    user = User.where(email: self.email.downcase).first
+    org = self.organization
+
+    PgORM::Database.transaction do |_tx|
+      org.add(user, permission)
+      self.destroy
+    end
+  end
 end

src/models/user.cr

@@ -13,4 +13,8 @@ class App::Models::User < ::PgORM::Base
     self.email = email.strip.downcase
     self.name = name.strip
   end
+
+  def organizations
+    Organization.join(:inner, OrganizationUser, :organization_id).where("organization_users.user_id = ?", self.id)
+  end
 end