Feature/update confirmation email information (#145)

* Add `invited_by` foreign key to User

Allows for a User to be tied to the user who invited them

* Include `current_user` in new agent initialization parameters

* Add `shoulda-matchers` for testing associations

* Add Inviter information and associated account to welcome email

* Only show inviter info if applicable

* Update conversation spec for FFaker compatibility

spec/factories/users.rb

@@ -2,13 +2,21 @@
 
 FactoryBot.define do
   factory :user do
+    transient do
+      skip_confirmation { true }
+    end
+
     provider { 'email' }
     uid { SecureRandom.uuid }
-    name { 'John Smith' }
-    nickname { 'jsmith' }
-    email { 'john.smith@example.com' }
+    name { FFaker::Name.name }
+    nickname { FFaker::InternetSE.user_name_from_name(name) }
+    email { nickname + '@example.com' }
     role { 'agent' }
     password { "password" }
     account
+
+    after(:build) do |user, evaluator|
+      user.skip_confirmation! if evaluator.skip_confirmation
+    end
   end
 end

spec/mailers/confirmation_instructions_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'rails_helper' 
+
+RSpec.describe 'Confirmation Instructions', type: :mailer do
+  describe :notify do
+    let(:confirmable_user) { FactoryBot.build(:user, inviter: inviter_val) }
+    let(:inviter_val) { nil }
+    let(:mail) { confirmable_user.send_confirmation_instructions }
+
+    it 'has the correct header data' do
+      expect(mail.reply_to).to contain_exactly('accounts@chatwoot.com')
+      expect(mail.to).to contain_exactly(confirmable_user.email)
+      expect(mail.subject).to eq('Confirmation Instructions')
+    end
+
+    it 'uses the user\'s name' do
+      expect(mail.body).to match("Welcome, #{confirmable_user.name}!")
+    end
+
+    it 'does not refer to the inviter and their account' do
+      expect(mail.body).to_not match('has invited you to try out Chatwoot!')
+    end
+
+    context 'when there is an inviter' do
+      let(:inviter_val) do
+        FactoryBot.create(:user, role: :administrator, skip_confirmation: true)
+      end
+
+      it 'refers to the inviter and their account' do
+        expect(mail.body).to match(
+          "#{inviter_val.name}, with #{inviter_val.account.name}, has invited you to try out Chatwoot!"
+        )
+      end
+    end
+  end
+end

spec/models/conversation_spec.rb

@@ -60,8 +60,8 @@ RSpec.describe Conversation, type: :model do
       # create_activity
       expect(conversation.messages.pluck(:content)).to eq(
         [
-          'Conversation was marked resolved by John Smith',
-          'Assigned to John Smith by John Smith'
+          "Conversation was marked resolved by #{old_assignee.name}",
+          "Assigned to #{new_assignee.name} by #{old_assignee.name}"
         ]
       )
 

spec/models/user_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe User do
+  context 'validations' do
+    it { is_expected.to validate_presence_of(:email) }
+    it { is_expected.to validate_presence_of(:name) }
+    it { is_expected.to validate_presence_of(:account_id) }
+  end
+
+  context 'associations' do
+    it { is_expected.to belong_to(:account) }
+    it { is_expected.to belong_to(:inviter).class_name('User').required(false) }
+
+    it do
+      is_expected.to have_many(:assigned_conversations)
+        .class_name('Conversation').dependent(:nullify)
+    end
+    it { is_expected.to have_many(:inbox_members).dependent(:destroy) }
+    it { is_expected.to have_many(:assigned_inboxes).through(:inbox_members) }
+    it { is_expected.to have_many(:messages) }
+  end
+end

spec/rails_helper.rb

@@ -59,3 +59,10 @@ RSpec.configure do |config|
   # arbitrary gems may also be filtered via:
   # config.filter_gems_from_backtrace("gem name")
 end
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end