PartnerGroup and PartnerGroupMembership models

- migrations
- factories
- validation specs

Author: albertchae

app/controllers/api/v1/partner_requests_controller.rb

@@ -22,6 +22,7 @@ def show
     return head :forbidden unless api_key_valid?
 
     organization = Organization.find(params[:id])
+    # replace this with items from partner group
     render json: organization.valid_items, status: :ok
   rescue ActiveRecord::RecordNotFound => e
     render json: { error: e.message }, status: :bad_request

app/models/organization.rb

@@ -45,6 +45,7 @@ class Organization < ApplicationRecord
     has_many :donations
     has_many :manufacturers
     has_many :partners
+    has_many :partner_groups
     has_many :purchases
     has_many :requests
     has_many :storage_locations

app/models/partner_group.rb

@@ -0,0 +1,18 @@
+# == Schema Information
+#
+# Table name: partner_groups
+#
+#  id              :bigint           not null, primary key
+#  name            :string
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#  organization_id :bigint
+#
+class PartnerGroup < ApplicationRecord
+  belongs_to :organization
+  has_many :partner_group_memberships
+  has_many :partners, through: :partner_group_memberships
+
+  validates :organization, presence: true
+  validates :name, presence: true, uniqueness: { scope: :organization }
+end

app/models/partner_group_membership.rb

@@ -0,0 +1,30 @@
+# == Schema Information
+#
+# Table name: partner_group_memberships
+#
+#  id               :bigint           not null, primary key
+#  created_at       :datetime         not null
+#  updated_at       :datetime         not null
+#  partner_group_id :bigint
+#  partner_id       :bigint
+#
+class PartnerGroupMembership < ApplicationRecord
+  belongs_to :partner_group
+  belongs_to :partner
+  has_one :organization, through: :partner_group
+
+  validates :partner_group, presence: true
+  validates :partner, presence: true, uniqueness: { scope: :partner_group }
+
+  validate :partner_belongs_to_partner_group_organization
+
+  private
+
+  def partner_belongs_to_partner_group_organization
+    return if organization.nil?
+
+    unless organization == partner.organization
+      errors.add :partner, "partner must belong to same organization as partner_group"
+    end
+  end
+end

db/migrate/20201230233305_create_partner_groups.rb

@@ -0,0 +1,10 @@
+class CreatePartnerGroups < ActiveRecord::Migration[6.0]
+  def change
+    create_table :partner_groups do |t|
+      t.references :organization, foreign_key: true
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20201230233349_create_partner_group_memberships.rb

@@ -0,0 +1,10 @@
+class CreatePartnerGroupMemberships < ActiveRecord::Migration[6.0]
+  def change
+    create_table :partner_group_memberships do |t|
+      t.references :partner_group, foreign_key: true
+      t.references :partner, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

db/schema.rb

@@ -11,6 +11,7 @@
 # It's strongly recommended that you check this file into your version control system.
 
 ActiveRecord::Schema.define(version: 20_210_107_175_100) do
+
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
@@ -289,6 +290,23 @@
     t.index ["short_name"], name: "index_organizations_on_short_name"
   end
 
+  create_table "partner_group_memberships", force: :cascade do |t|
+    t.bigint "partner_group_id"
+    t.bigint "partner_id"
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+    t.index ["partner_group_id"], name: "index_partner_group_memberships_on_partner_group_id"
+    t.index ["partner_id"], name: "index_partner_group_memberships_on_partner_id"
+  end
+
+  create_table "partner_groups", force: :cascade do |t|
+    t.bigint "organization_id"
+    t.string "name"
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+    t.index ["organization_id"], name: "index_partner_groups_on_organization_id"
+  end
+
   create_table "partners", id: :serial, force: :cascade do |t|
     t.string "name"
     t.string "email"
@@ -418,6 +436,9 @@
   add_foreign_key "kits", "organizations"
   add_foreign_key "manufacturers", "organizations"
   add_foreign_key "organizations", "account_requests"
+  add_foreign_key "partner_group_memberships", "partner_groups"
+  add_foreign_key "partner_group_memberships", "partners"
+  add_foreign_key "partner_groups", "organizations"
   add_foreign_key "requests", "organizations"
   add_foreign_key "requests", "partners"
 end

spec/factories/partner_group_memberships.rb

@@ -0,0 +1,17 @@
+# == Schema Information
+#
+# Table name: partner_group_memberships
+#
+#  id               :bigint           not null, primary key
+#  created_at       :datetime         not null
+#  updated_at       :datetime         not null
+#  partner_group_id :bigint
+#  partner_id       :bigint
+#
+
+FactoryBot.define do
+  factory :partner_group_membership do
+    partner_group
+    partner
+  end
+end

spec/factories/partner_groups.rb

@@ -0,0 +1,17 @@
+# == Schema Information
+#
+# Table name: partner_groups
+#
+#  id              :bigint           not null, primary key
+#  name            :string
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#  organization_id :bigint
+#
+
+FactoryBot.define do
+  factory :partner_group do
+    sequence(:name) { |n| "Group #{n}" }
+    organization { Organization.try(:first) || create(:organization) }
+  end
+end

spec/models/partner_group_membership_spec.rb

@@ -0,0 +1,36 @@
+# == Schema Information
+#
+# Table name: partner_group_memberships
+#
+#  id               :bigint           not null, primary key
+#  created_at       :datetime         not null
+#  updated_at       :datetime         not null
+#  partner_group_id :bigint
+#  partner_id       :bigint
+#
+RSpec.describe PartnerGroupMembership, type: :model do
+  context "Validations >" do
+    it "must belong to a partner_group" do
+      expect(build(:partner_group_membership, partner_group_id: nil)).not_to be_valid
+    end
+
+    it "must belong to a partner" do
+      expect(build(:partner_group_membership, partner_id: nil)).not_to be_valid
+    end
+
+    it "a partner can only be a member of a partner_group once" do
+      membership = create(:partner_group_membership)
+      expect(build(:partner_group_membership,
+                   partner_group: membership.partner_group,
+                   partner: membership.partner)).not_to be_valid
+    end
+
+    it "a partner must belong to the same organization as the partner_group" do
+      partner_group = create(:partner_group, organization: create(:organization))
+      partner = create(:partner, organization: create(:organization))
+      expect(build(:partner_group_membership,
+                   partner_group: partner_group,
+                   partner: partner)).not_to be_valid
+    end
+  end
+end