openstax_accounts 7.9.0 → 7.10.0

data/spec/factories/openstax_accounts_account.rb

@@ -1,10 +1,11 @@
 FactoryBot.define do
   factory :openstax_accounts_account, class: OpenStax::Accounts::Account do
-    openstax_uid   { -SecureRandom.hex(4).to_i(16)/2 }
-    username       { SecureRandom.hex.to_s }
-    access_token   { SecureRandom.hex.to_s }
-    faculty_status { OpenStax::Accounts::Account.faculty_statuses[:no_faculty_info] }
-    role           { OpenStax::Accounts::Account.roles[:unknown_role] }
-    uuid           { SecureRandom.uuid }
+    openstax_uid       { -SecureRandom.hex(4).to_i(16)/2 }
+    username           { SecureRandom.hex.to_s }
+    access_token       { SecureRandom.hex.to_s }
+    faculty_status     { OpenStax::Accounts::Account.faculty_statuses[:no_faculty_info] }
+    role               { OpenStax::Accounts::Account.roles[:unknown_role] }
+    uuid               { SecureRandom.uuid }
+    support_identifier { "cs_#{SecureRandom.hex(4)}" }
   end
 end

data/spec/handlers/openstax/accounts/accounts_search_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module OpenStax
   module Accounts
 
-    describe AccountsSearch do
+    RSpec.describe AccountsSearch do
       
       let!(:account_1)          { FactoryBot.create :openstax_accounts_account,
                                                   first_name: 'John',

data/spec/handlers/openstax/accounts/dev/accounts_search_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module OpenStax
   module Accounts
 
-    describe Dev::AccountsSearch do
+    RSpec.describe Dev::AccountsSearch do
       
       let!(:account_1)          { FactoryBot.create :openstax_accounts_account,
                                                   first_name: 'John',

data/spec/handlers/openstax/accounts/sessions_callback_spec.rb

@@ -3,22 +3,25 @@ require 'spec_helper'
 module OpenStax
   module Accounts
 
-    describe SessionsCallback do
+    RSpec.describe SessionsCallback do
 
       context "faculty_status" do
-        it "should deal with faculty status it doesn't know (e.g. if Accounts updated but this repo not)" do
-          result = described_class.handle(request: mock_omniauth_request(faculty_status: "howdy_ho"))
+        it "should default to no_faculty_info if the received faculty_status is unknown" +
+           " (e.g. if Accounts is updated but this repo is not)" do
+          result = described_class.handle(
+            request: mock_omniauth_request(faculty_status: "howdy_ho")
+          )
           expect(result.outputs.account).to be_no_faculty_info
         end
 
-        it "should deal with faculty status that is not present" do
+        it "should default to no_faculty_info if faculty status is not present" do
           request = mock_omniauth_request()
           remove_faculty_status!(request)
           result = described_class.handle(request: request)
           expect(result.outputs.account).to be_no_faculty_info
         end
 
-        it "should deal with null nickname" do
+        it "should deal with null nicknames" do
           with_stubbing(false) do
             request = mock_omniauth_request
             remove_nickname!(request)
@@ -37,14 +40,28 @@ module OpenStax
         end
       end
 
+      context "support_identifier" do
+        it "sets the support_identifier on the account" do
+          support_identifier = "cs_#{SecureRandom.hex(4)}"
+          result = described_class.handle(
+            request: mock_omniauth_request(support_identifier: support_identifier)
+          )
+          expect(result.outputs.account.support_identifier).to eq support_identifier
+        end
+      end
+
       context "role" do
         it "sets the role on the account" do
-          result = described_class.handle(request: mock_omniauth_request(self_reported_role: "instructor"))
+          result = described_class.handle(
+            request: mock_omniauth_request(self_reported_role: "instructor")
+          )
           expect(result.outputs.account.role).to eq "instructor"
         end
 
         it "deals with unknown role (e.g. if Accounts update but this repo not)" do
-          result = described_class.handle(request: mock_omniauth_request(self_reported_role: "howdy_ho"))
+          result = described_class.handle(
+            request: mock_omniauth_request(self_reported_role: "howdy_ho")
+          )
           expect(result.outputs.account).to be_unknown_role
         end
       end
@@ -53,6 +70,7 @@ module OpenStax
         it "updates the user's data" do
           existing_account = FactoryBot.create :openstax_accounts_account
           uuid = SecureRandom.uuid
+          support_identifier = "cs_#{SecureRandom.hex(4)}"
           result = described_class.handle(
             request: mock_omniauth_request(
               uid: existing_account.openstax_uid,
@@ -62,6 +80,7 @@ module OpenStax
               nickname: "191919",
               faculty_status: "confirmed_faculty",
               uuid: uuid,
+              support_identifier: support_identifier,
               self_reported_role: "instructor")
           )
 
@@ -73,6 +92,7 @@ module OpenStax
           expect(account.username).to eq "191919"
           expect(account).to be_confirmed_faculty
           expect(account.uuid).to eq uuid
+          expect(account.support_identifier).to eq support_identifier
           expect(account).to be_instructor
         end
       end

data/spec/lib/openstax/accounts/api_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module OpenStax
   module Accounts
-    describe Api do
+    RSpec.describe Api do
 
       let!(:account) { OpenStax::Accounts::Account.create(username: 'some_user',
                          first_name: 'Some', last_name: 'User', full_name: 'SomeUser',

data/spec/lib/openstax/accounts/configuration_spec.rb

@@ -1,6 +1,6 @@
 module OpenStax
   module Accounts
-    describe Configuration do
+    RSpec.describe Configuration do
 
       let!(:config) { Configuration.new.tap {|c| c.openstax_accounts_url = "https://accounts.openstax.org"} }
       let!(:a_fake_request) { OpenStruct.new(url: "http://foo.com") }

data/spec/lib/openstax/accounts/current_user_manager_spec.rb

@@ -1,6 +1,6 @@
 module OpenStax
   module Accounts
-    describe CurrentUserManager do
+    RSpec.describe CurrentUserManager do
       let!(:account) { FactoryBot.create(:openstax_accounts_account,
                          username: 'some_user',
                          openstax_uid: 1) }

data/spec/lib/openstax/accounts/has_many_through_groups/active_record/base_spec.rb

@@ -2,7 +2,7 @@ module OpenStax
   module Accounts
     module HasManyThroughGroups
       module ActiveRecord
-        describe Base do
+        RSpec.describe Base do
           let!(:account_1) { FactoryBot.create(:openstax_accounts_account,
                              username: 'some_user',
                              openstax_uid: 1) }

data/spec/models/openstax/accounts/account_spec.rb

@@ -1,9 +1,13 @@
 require 'spec_helper'
 
 module OpenStax::Accounts
-  RSpec.describe Account do
+  RSpec.describe Account, type: :model do
     subject(:account) { FactoryBot.create(:openstax_accounts_account) }
 
+    it { is_expected.to validate_presence_of(:uuid) }
+    it { is_expected.to validate_uniqueness_of(:uuid).case_insensitive }
+    it { is_expected.to validate_uniqueness_of(:support_identifier).case_insensitive.allow_nil }
+
     context 'validation' do
       it 'requires a unique openstax_uid, if given' do
         account.openstax_uid = nil

data/spec/models/openstax/accounts/anonymous_account_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module OpenStax::Accounts
-  describe AnonymousAccount do
+  RSpec.describe AnonymousAccount, type: :model do
     it 'is anonymous' do
       expect(AnonymousAccount.instance.is_anonymous?).to eq true
     end

data/spec/models/openstax/accounts/group_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module OpenStax::Accounts
-  describe Group do
+  RSpec.describe Group, type: :model do
     context 'validation' do
       it 'requires a unique openstax_uid' do
         group = FactoryBot.build(:openstax_accounts_group, openstax_uid: nil)

data/spec/routines/openstax/accounts/create_group_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module OpenStax
   module Accounts
 
-    describe CreateGroup, type: :routine do
+    RSpec.describe CreateGroup, type: :routine do
 
       before(:all) do
         @previous_enable_stubbing = OpenStax::Accounts.configuration.enable_stubbing

data/spec/routines/openstax/accounts/find_or_create_account_spec.rb

@@ -4,7 +4,7 @@ require 'vcr_helper'
 module OpenStax
   module Accounts
 
-    describe FindOrCreateAccount, type: :routine, vcr: VCR_OPTS do
+    RSpec.describe FindOrCreateAccount, type: :routine, vcr: VCR_OPTS do
 
       before(:all) do
         @previous_url = OpenStax::Accounts.configuration.openstax_accounts_url
@@ -15,17 +15,22 @@ module OpenStax
       end
 
       it 'can create users' do
-        account_1 = FindOrCreateAccount.call(email: 'alice@example.com', role: 'instructor').outputs.account
+        account_1 = described_class.call(
+          email: 'alice@example.com', role: 'instructor'
+        ).outputs.account
         expect(account_1).to be_persisted
-        expect(account_1.uuid).to match(/\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i)
+        expect(account_1.uuid).to(
+          match(/\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i)
+        )
+        expect(account_1.support_identifier).to match(/\Acs_[0-9a-f]{8}\z/i)
         expect(account_1.role).to eq 'instructor'
 
-        account_2 = FindOrCreateAccount.call(username: 'alice').outputs.account
+        account_2 = described_class.call(username: 'alice').outputs.account
         expect(account_2).to be_persisted
         expect(account_1).not_to eq(account_2)
 
-        account_3 = FindOrCreateAccount.call(username: 'alice2',
-                                             password: 'abcdefghijklmnop').outputs.account
+        account_3 = described_class.call(username: 'alice2',
+                                         password: 'abcdefghijklmnop').outputs.account
         expect(account_3).to be_persisted
         expect(account_1).not_to eq(account_3)
         expect(account_2).not_to eq(account_3)
@@ -34,7 +39,12 @@ module OpenStax
       it 'passes params to the API when creating users' do
         find_or_create_account_response = double('Response')
         allow(find_or_create_account_response).to receive(:status).and_return(201)
-        allow(find_or_create_account_response).to receive(:body).and_return('{"id":1}')
+        allow(find_or_create_account_response).to(
+          receive(:body).and_return(
+            "{\"id\":1,\"uuid\":\"#{SecureRandom.uuid
+            }\",\"support_identifier\":\"cs_#{SecureRandom.hex(4)}\"}"
+          )
+        )
         expect(OpenStax::Accounts::Api).to receive(:find_or_create_account).with(
           email: 'bob@example.com', username: nil, password: nil,
           first_name: 'Bob', last_name: 'Smith', full_name: 'Bob Smith',
@@ -42,7 +52,7 @@ module OpenStax
           role: :instructor
         ).and_return(find_or_create_account_response)
 
-        FindOrCreateAccount.call(
+        described_class.call(
           email: 'bob@example.com',
           first_name: 'Bob',
           last_name: 'Smith',

data/spec/routines/openstax/accounts/search_accounts_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module OpenStax
   module Accounts
 
-    describe SearchAccounts, type: :routine do
+    RSpec.describe SearchAccounts, type: :routine do
 
       let!(:account_1)          { FactoryBot.create :openstax_accounts_account,
                                                   first_name: 'John',

data/spec/routines/openstax/accounts/sync_accounts_spec.rb

@@ -3,11 +3,14 @@ require 'spec_helper'
 module OpenStax
   module Accounts
 
-    describe SyncAccounts, type: :routine do
+    RSpec.describe SyncAccounts, type: :routine do
 
       it 'can sync accounts' do
         controller_class = ::Api::ApplicationUsersController
-        uuid = SecureRandom.uuid
+        uuid_1 = SecureRandom.uuid
+        uuid_2 = SecureRandom.uuid
+        support_identifier_1 = "cs_#{SecureRandom.hex(4)}"
+        support_identifier_2 = "cs_#{SecureRandom.hex(4)}"
         allow_any_instance_of(controller_class).to(
           receive(:updates) do |controller|
             controller.render json: [
@@ -17,8 +20,9 @@ module OpenStax
                 user: {
                   id: 2,
                   username: 'user',
-                  self_reported_role: 'instructor',
-                  uuid: uuid
+                  uuid: uuid_1,
+                  support_identifier: support_identifier_1,
+                  self_reported_role: 'instructor'
                 },
                 unread_updates: 1,
                 default_contact_info_id: 1
@@ -28,6 +32,8 @@ module OpenStax
                 application_id: 1,
                 user: {
                   id: 4,
+                  uuid: uuid_2,
+                  support_identifier: support_identifier_2,
                   username: 'fuego'
                 },
                 unread_updates: 2,
@@ -37,46 +43,50 @@ module OpenStax
           end
         )
 
-        account = OpenStax::Accounts::Account.new
-        account.username = 'u'
-        account.openstax_uid = 2
+        account = FactoryBot.create :openstax_accounts_account, username: 'u', openstax_uid: 2
         account.syncing = true
-        account.save!
 
         begin
           OpenStax::Accounts.configuration.enable_stubbing = false
-          expect(Account.count).to eq 1
-          expect(Account.first.openstax_uid).to eq 2
-          expect(Account.first.username).to eq 'u'
+          expect(account.reload.openstax_uid).to eq 2
+          expect(account.username).to eq 'u'
+          expect(Account.find_by(openstax_uid: 4)).to be_nil
 
           controller_class.last_action = nil
           controller_class.last_json = nil
-          SyncAccounts.call
-          expect(Account.count).to eq 2
-          expect(Account.first.openstax_uid).to eq 2
-          expect(Account.first.username).to eq 'user'
-          expect(Account.first.role).to eq 'instructor'
-          expect(Account.first.uuid).to eq uuid
-          expect(Account.last.openstax_uid).to eq 4
-          expect(Account.last.username).to eq 'fuego'
+
+          expect { SyncAccounts.call }.to change { Account.count }.by(1)
+
+          account2 = Account.find_by(openstax_uid: 4)
+
+          expect(account.reload.openstax_uid).to eq 2
+          expect(account.username).to eq 'user'
+          expect(account.role).to eq 'instructor'
+          expect(account.uuid).to eq uuid_1
+          expect(account.support_identifier).to eq support_identifier_1
+          expect(account2.username).to eq 'fuego'
+          expect(account2.uuid).to eq uuid_2
+          expect(account2.support_identifier).to eq support_identifier_2
 
           expect(controller_class.last_action).to eq :updated
-          expect(controller_class.last_json).to eq [{'user_id' => 2, 'read_updates' => 1},
-                                                    {'user_id' => 4, 'read_updates' => 2}]
+          expect(controller_class.last_json).to eq [
+            {'user_id' => 2, 'read_updates' => 1}, {'user_id' => 4, 'read_updates' => 2}
+          ]
 
           controller_class.last_action = nil
           controller_class.last_json = nil
 
-          SyncAccounts.call
-          expect(Account.count).to eq 2
-          expect(Account.first.openstax_uid).to eq 2
-          expect(Account.first.username).to eq 'user'
-          expect(Account.last.openstax_uid).to eq 4
-          expect(Account.last.username).to eq 'fuego'
+          expect { SyncAccounts.call }.not_to change { Account.count }
+
+          expect(account.reload.openstax_uid).to eq 2
+          expect(account.username).to eq 'user'
+          expect(account2.reload.openstax_uid).to eq 4
+          expect(account2.username).to eq 'fuego'
 
           expect(controller_class.last_action).to eq :updated
-          expect(controller_class.last_json).to eq [{'user_id' => 2, 'read_updates' => 1},
-                                                    {'user_id' => 4, 'read_updates' => 2}]
+          expect(controller_class.last_json).to eq [
+            {'user_id' => 2, 'read_updates' => 1}, {'user_id' => 4, 'read_updates' => 2}
+          ]
         ensure
           OpenStax::Accounts.configuration.enable_stubbing = true
         end

data/spec/routines/openstax/accounts/sync_groups_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module OpenStax
   module Accounts
 
-    describe SyncGroups, type: :routine do
+    RSpec.describe SyncGroups, type: :routine do
 
       it 'can sync groups' do
         controller_class = ::Api::ApplicationGroupsController
@@ -61,95 +61,77 @@ module OpenStax
           end
         )
 
-        u = OpenStax::Accounts::Account.new
-        u.openstax_uid = 2
-        u.username = 'User'
+        u = FactoryBot.create :openstax_accounts_account, openstax_uid: 2, username: 'User'
         u.syncing = true
-        u.save!
 
-        u2 = OpenStax::Accounts::Account.new
-        u2.openstax_uid = 3
-        u2.username = 'Fuego'
+        u2 = FactoryBot.create :openstax_accounts_account, openstax_uid: 3, username: 'Fuego'
         u2.syncing = true
-        u2.save!
 
-        g = OpenStax::Accounts::Group.new
-        g.name = 'Member Group'
-        g.openstax_uid = 2
+        g = FactoryBot.create :openstax_accounts_group, openstax_uid: 2, name: 'Member Group'
         g.syncing = true
-        g.save!
 
-        gm = GroupMember.new
-        gm.group = g
-        gm.user = u
-        gm.save!
+        gm = FactoryBot.create :openstax_accounts_group_member, group: g, user: u
 
-        g2 = OpenStax::Accounts::Group.new
-        g2.name = 'Container Group'
-        g2.openstax_uid = 4
+        g2 = FactoryBot.create :openstax_accounts_group, openstax_uid: 4, name: 'Container Group'
         g2.syncing = true
-        g2.save!
 
-        go = GroupOwner.new
-        go.group = g2
-        go.user = u
-        go.save!
+        go = FactoryBot.create :openstax_accounts_group_owner, group: g2, user: u
 
-        gn = GroupNesting.new
-        gn.container_group = g2
-        gn.member_group = g
-        gn.save!
+        gn = FactoryBot.create :openstax_accounts_group_nesting, container_group: g2,
+                                                                 member_group: g
 
         begin
           OpenStax::Accounts.configuration.enable_stubbing = false
-          expect(Group.count).to eq 2
-          expect(Group.first.openstax_uid).to eq 2
-          expect(Group.first.name).to eq 'Member Group'
-          expect(Group.first.members).to include u
-          expect(Group.last.openstax_uid).to eq 4
-          expect(Group.last.name).to eq 'Container Group'
-          expect(Group.last.member_groups).to include g
-          expect(Group.last.owners).to include u
+          expect(g.reload.openstax_uid).to eq 2
+          expect(g.name).to eq 'Member Group'
+          expect(g.members).to eq [ u ]
+          expect(g2.reload.openstax_uid).to eq 4
+          expect(g2.name).to eq 'Container Group'
+          expect(g2.member_groups).to eq [ g ]
+          expect(g2.owners).to eq [ u ]
 
           controller_class.last_action = nil
           controller_class.last_json = nil
 
-          SyncGroups.call
-          expect(Group.count).to eq 3
-          expect(Group.first.openstax_uid).to eq 2
-          expect(Group.first.name).to eq 'M'
-          expect(Group.first.member_groups).to include Group.last
-          expect(Group.all.second.openstax_uid).to eq 4
-          expect(Group.all.second.name).to eq 'Container Group'
-          expect(Group.all.second.member_groups).to include Group.first
-          expect(Group.last.openstax_uid).to eq 3
-          expect(Group.last.name).to eq 'Fuego\'s Deputies'
-          expect(Group.last.owners).to include Account.last
-          expect(Group.last.members).to include Account.first
+          expect { SyncGroups.call }.to change { Group.count }.by(1)
+
+          g3 = Group.find_by(openstax_uid: 3)
+
+          expect(g.reload.openstax_uid).to eq 2
+          expect(g.name).to eq 'M'
+          expect(g.member_groups).to eq [ g3 ]
+          expect(g2.reload.openstax_uid).to eq 4
+          expect(g2.name).to eq 'Container Group'
+          expect(g2.member_groups).to eq [ g ]
+          expect(g3.name).to eq 'Fuego\'s Deputies'
+          expect(g3.owners).to eq [ u2 ]
+          expect(g3.members).to eq [ u ]
 
           expect(controller_class.last_action).to eq :updated
-          expect(controller_class.last_json).to eq [{'group_id' => 2, 'read_updates' => 1},
-                                                    {'group_id' => 3, 'read_updates' => 2}]
+          expect(controller_class.last_json).to eq [
+            {'group_id' => 2, 'read_updates' => 1}, {'group_id' => 3, 'read_updates' => 2}
+          ]
 
           controller_class.last_action = nil
           controller_class.last_json = nil
 
-          SyncGroups.call
-          expect(Group.count).to eq 3
-          expect(Group.first.openstax_uid).to eq 2
-          expect(Group.first.name).to eq 'M'
-          expect(Group.first.member_groups).to include Group.last
-          expect(Group.all.second.openstax_uid).to eq 4
-          expect(Group.all.second.name).to eq 'Container Group'
-          expect(Group.all.second.member_groups).to include Group.first
-          expect(Group.last.openstax_uid).to eq 3
-          expect(Group.last.name).to eq 'Fuego\'s Deputies'
-          expect(Group.last.owners).to include Account.last
-          expect(Group.last.members).to include Account.first
+          expect { SyncGroups.call }.not_to change { Group.count }
+
+          expect(g.reload.openstax_uid).to eq 2
+          expect(g.name).to eq 'M'
+          expect(g.member_groups).to eq [ g3 ]
+          expect(g2.reload.openstax_uid).to eq 4
+          expect(g2.name).to eq 'Container Group'
+          expect(g2.member_groups).to eq [ g ]
+          expect(g3.reload.openstax_uid).to eq 3
+          expect(g3.name).to eq 'Fuego\'s Deputies'
+          expect(g3.owners).to eq [ u2 ]
+          expect(g3.members).to eq [ u ]
 
           expect(controller_class.last_action).to eq :updated
-          expect(controller_class.last_json).to eq [{'group_id' => 2, 'read_updates' => 1},
-                                                    {'group_id' => 3, 'read_updates' => 2}]
+          expect(controller_class.last_json).to eq [
+            {'group_id' => 2, 'read_updates' => 1}, {'group_id' => 3, 'read_updates' => 2}
+          ]
         ensure
           OpenStax::Accounts.configuration.enable_stubbing = true
         end