scimitar 2.2.0 → 2.4.0

data/spec/requests/active_record_backed_resources_controller_spec.rb

@@ -5,11 +5,21 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
   before :each do
     allow_any_instance_of(Scimitar::ApplicationController).to receive(:authenticated?).and_return(true)
 
+    # If a sort order is unspecified, the controller defaults to ID ascending.
+    # With UUID based IDs, testing life is made easier by ensuring that the
+    # creation order matches an ascending UUID sort order (which is what would
+    # happen if we were using integer primary keys).
+    #
     lmt = Time.parse("2023-01-09 14:25:00 +1300")
+    ids = 3.times.map { SecureRandom.uuid }.sort()
 
-    @u1 = MockUser.create(username: '1', first_name: 'Foo', last_name: 'Ark', home_email_address: 'home_1@test.com', scim_uid: '001', created_at: lmt, updated_at: lmt + 1)
-    @u2 = MockUser.create(username: '2', first_name: 'Foo', last_name: 'Bar', home_email_address: 'home_2@test.com', scim_uid: '002', created_at: lmt, updated_at: lmt + 2)
-    @u3 = MockUser.create(username: '3', first_name: 'Foo',                   home_email_address: 'home_3@test.com', scim_uid: '003', created_at: lmt, updated_at: lmt + 3)
+    @u1 = MockUser.create(primary_key: ids.shift(), username: '1', first_name: 'Foo', last_name: 'Ark', home_email_address: 'home_1@test.com', scim_uid: '001', created_at: lmt, updated_at: lmt + 1)
+    @u2 = MockUser.create(primary_key: ids.shift(), username: '2', first_name: 'Foo', last_name: 'Bar', home_email_address: 'home_2@test.com', scim_uid: '002', created_at: lmt, updated_at: lmt + 2)
+    @u3 = MockUser.create(primary_key: ids.shift(), username: '3', first_name: 'Foo',                   home_email_address: 'home_3@test.com', scim_uid: '003', created_at: lmt, updated_at: lmt + 3)
+
+    @g1 = MockGroup.create!(display_name: 'Group 1')
+    @g2 = MockGroup.create!(display_name: 'Group 2')
+    @g3 = MockGroup.create!(display_name: 'Group 3')
   end
 
   # ===========================================================================
@@ -32,21 +42,41 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
     end # "context 'with no items' do"
 
     context 'with items' do
-      it 'returns all items' do
-        get '/Users', params: { format: :scim }
+      context 'with a UUID, renamed primary key column' do
+        it 'returns all items' do
+          get '/Users', params: { format: :scim }
 
-        expect(response.status).to eql(200)
-        result = JSON.parse(response.body)
+          expect(response.status).to eql(200)
+          result = JSON.parse(response.body)
 
-        expect(result['totalResults']).to eql(3)
-        expect(result['Resources'].size).to eql(3)
+          expect(result['totalResults']).to eql(3)
+          expect(result['Resources'].size).to eql(3)
 
-        ids = result['Resources'].map { |resource| resource['id'] }
-        expect(ids).to match_array([@u1.id.to_s, @u2.id.to_s, @u3.id.to_s])
+          ids = result['Resources'].map { |resource| resource['id'] }
+          expect(ids).to match_array([@u1.primary_key.to_s, @u2.primary_key.to_s, @u3.primary_key.to_s])
 
-        usernames = result['Resources'].map { |resource| resource['userName'] }
-        expect(usernames).to match_array(['1', '2', '3'])
-      end
+          usernames = result['Resources'].map { |resource| resource['userName'] }
+          expect(usernames).to match_array(['1', '2', '3'])
+        end
+      end # "context 'with a UUID, renamed primary key column' do"
+
+      context 'with an integer, conventionally named primary key column' do
+        it 'returns all items' do
+          get '/Groups', params: { format: :scim }
+
+          expect(response.status).to eql(200)
+          result = JSON.parse(response.body)
+
+          expect(result['totalResults']).to eql(3)
+          expect(result['Resources'].size).to eql(3)
+
+          ids = result['Resources'].map { |resource| resource['id'] }
+          expect(ids).to match_array([@g1.id.to_s, @g2.id.to_s, @g3.id.to_s])
+
+          usernames = result['Resources'].map { |resource| resource['displayName'] }
+          expect(usernames).to match_array(['Group 1', 'Group 2', 'Group 3'])
+        end
+      end # "context 'with an integer, conventionally named primary key column' do"
 
       it 'applies a filter, with case-insensitive value comparison' do
         get '/Users', params: {
@@ -61,7 +91,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         expect(result['Resources'].size).to eql(1)
 
         ids = result['Resources'].map { |resource| resource['id'] }
-        expect(ids).to match_array([@u2.id.to_s])
+        expect(ids).to match_array([@u2.primary_key.to_s])
 
         usernames = result['Resources'].map { |resource| resource['userName'] }
         expect(usernames).to match_array(['2'])
@@ -80,7 +110,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         expect(result['Resources'].size).to eql(1)
 
         ids = result['Resources'].map { |resource| resource['id'] }
-        expect(ids).to match_array([@u2.id.to_s])
+        expect(ids).to match_array([@u2.primary_key.to_s])
 
         usernames = result['Resources'].map { |resource| resource['userName'] }
         expect(usernames).to match_array(['2'])
@@ -93,7 +123,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         it 'applies a filter on primary keys, using direct comparison (rather than e.g. case-insensitive operators)' do
           get '/Users', params: {
             format: :scim,
-            filter: "id eq \"#{@u3.id}\""
+            filter: "id eq \"#{@u3.primary_key}\""
           }
 
           expect(response.status).to eql(200)
@@ -103,7 +133,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
           expect(result['Resources'].size).to eql(1)
 
           ids = result['Resources'].map { |resource| resource['id'] }
-          expect(ids).to match_array([@u3.id.to_s])
+          expect(ids).to match_array([@u3.primary_key.to_s])
 
           usernames = result['Resources'].map { |resource| resource['userName'] }
           expect(usernames).to match_array(['3'])
@@ -122,7 +152,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
           expect(result['Resources'].size).to eql(1)
 
           ids = result['Resources'].map { |resource| resource['id'] }
-          expect(ids).to match_array([@u2.id.to_s])
+          expect(ids).to match_array([@u2.primary_key.to_s])
 
           usernames = result['Resources'].map { |resource| resource['userName'] }
           expect(usernames).to match_array(['2'])
@@ -141,7 +171,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
           expect(result['Resources'].size).to eql(1)
 
           ids = result['Resources'].map { |resource| resource['id'] }
-          expect(ids).to match_array([@u3.id.to_s])
+          expect(ids).to match_array([@u3.primary_key.to_s])
 
           usernames = result['Resources'].map { |resource| resource['userName'] }
           expect(usernames).to match_array(['3'])
@@ -161,7 +191,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         expect(result['Resources'].size).to eql(2)
 
         ids = result['Resources'].map { |resource| resource['id'] }
-        expect(ids).to match_array([@u1.id.to_s, @u2.id.to_s])
+        expect(ids).to match_array([@u1.primary_key.to_s, @u2.primary_key.to_s])
 
         usernames = result['Resources'].map { |resource| resource['userName'] }
         expect(usernames).to match_array(['1', '2'])
@@ -180,7 +210,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         expect(result['Resources'].size).to eql(2)
 
         ids = result['Resources'].map { |resource| resource['id'] }
-        expect(ids).to match_array([@u2.id.to_s, @u3.id.to_s])
+        expect(ids).to match_array([@u2.primary_key.to_s, @u3.primary_key.to_s])
 
         usernames = result['Resources'].map { |resource| resource['userName'] }
         expect(usernames).to match_array(['2', '3'])
@@ -204,18 +234,34 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
   # ===========================================================================
 
   context '#show' do
-    it 'shows an item' do
-      expect_any_instance_of(MockUsersController).to receive(:show).once.and_call_original
-      get "/Users/#{@u2.id}", params: { format: :scim }
+    context 'with a UUID, renamed primary key column' do
+      it 'shows an item' do
+        expect_any_instance_of(MockUsersController).to receive(:show).once.and_call_original
+        get "/Users/#{@u2.primary_key}", params: { format: :scim }
 
-      expect(response.status).to eql(200)
-      result = JSON.parse(response.body)
+        expect(response.status).to eql(200)
+        result = JSON.parse(response.body)
 
-      expect(result['id']).to eql(@u2.id.to_s) # Note - ID was converted String; not Integer
-      expect(result['userName']).to eql('2')
-      expect(result['name']['familyName']).to eql('Bar')
-      expect(result['meta']['resourceType']).to eql('User')
-    end
+        expect(result['id']).to eql(@u2.primary_key.to_s)
+        expect(result['userName']).to eql('2')
+        expect(result['name']['familyName']).to eql('Bar')
+        expect(result['meta']['resourceType']).to eql('User')
+      end
+    end # "context 'with a UUID, renamed primary key column' do"
+
+    context 'with an integer, conventionally named primary key column' do
+      it 'shows an item' do
+        expect_any_instance_of(MockGroupsController).to receive(:show).once.and_call_original
+        get "/Groups/#{@g2.id}", params: { format: :scim }
+
+        expect(response.status).to eql(200)
+        result = JSON.parse(response.body)
+
+        expect(result['id']).to eql(@g2.id.to_s) # Note - ID was converted String; not Integer
+        expect(result['displayName']).to eql('Group 2')
+        expect(result['meta']['resourceType']).to eql('Group')
+      end
+    end # "context 'with an integer, conventionally named primary key column' do"
 
     it 'renders 404' do
       get '/Users/xyz', params: { format: :scim }
@@ -234,7 +280,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         it 'with minimal parameters' do
           mock_before = MockUser.all.to_a
 
-          attributes = { userName: '4' }  # Minimum required by schema
+          attributes = { userName: '4' } # Minimum required by schema
           attributes = spec_helper_hupcase(attributes) if force_upper_case
 
           expect_any_instance_of(MockUsersController).to receive(:create).once.and_call_original
@@ -248,7 +294,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
           expect(response.status).to eql(201)
           result = JSON.parse(response.body)
 
-          expect(result['id']).to eql(new_mock.id.to_s)
+          expect(result['id']).to eql(new_mock.primary_key.to_s)
           expect(result['meta']['resourceType']).to eql('User')
           expect(new_mock.username).to eql('4')
         end
@@ -363,13 +409,13 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
         expect_any_instance_of(MockUsersController).to receive(:replace).once.and_call_original
         expect {
-          put "/Users/#{@u2.id}", params: attributes.merge(format: :scim)
+          put "/Users/#{@u2.primary_key}", params: attributes.merge(format: :scim)
         }.to_not change { MockUser.count }
 
         expect(response.status).to eql(200)
         result = JSON.parse(response.body)
 
-        expect(result['id']).to eql(@u2.id.to_s)
+        expect(result['id']).to eql(@u2.primary_key.to_s)
         expect(result['meta']['resourceType']).to eql('User')
 
         @u2.reload
@@ -391,7 +437,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
     it 'notes schema validation failures' do
       expect {
-        put "/Users/#{@u2.id}", params: {
+        put "/Users/#{@u2.primary_key}", params: {
           format: :scim
           # userName parameter is required by schema, but missing
         }
@@ -470,13 +516,13 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
         expect_any_instance_of(MockUsersController).to receive(:update).once.and_call_original
         expect {
-          patch "/Users/#{@u2.id}", params: payload.merge(format: :scim)
+          patch "/Users/#{@u2.primary_key}", params: payload.merge(format: :scim)
         }.to_not change { MockUser.count }
 
         expect(response.status).to eql(200)
         result = JSON.parse(response.body)
 
-        expect(result['id']).to eql(@u2.id.to_s)
+        expect(result['id']).to eql(@u2.primary_key.to_s)
         expect(result['meta']['resourceType']).to eql('User')
 
         @u2.reload
@@ -507,13 +553,13 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
           expect_any_instance_of(MockUsersController).to receive(:update).once.and_call_original
           expect {
-            patch "/Users/#{@u2.id}", params: payload.merge(format: :scim)
+            patch "/Users/#{@u2.primary_key}", params: payload.merge(format: :scim)
           }.to_not change { MockUser.count }
 
           expect(response.status).to eql(200)
           result = JSON.parse(response.body)
 
-          expect(result['id']).to eql(@u2.id.to_s)
+          expect(result['id']).to eql(@u2.primary_key.to_s)
           expect(result['meta']['resourceType']).to eql('User')
 
           @u2.reload
@@ -539,13 +585,13 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
           expect_any_instance_of(MockUsersController).to receive(:update).once.and_call_original
           expect {
-            patch "/Users/#{@u2.id}", params: payload.merge(format: :scim)
+            patch "/Users/#{@u2.primary_key}", params: payload.merge(format: :scim)
           }.to_not change { MockUser.count }
 
           expect(response.status).to eql(200)
           result = JSON.parse(response.body)
 
-          expect(result['id']).to eql(@u2.id.to_s)
+          expect(result['id']).to eql(@u2.primary_key.to_s)
           expect(result['meta']['resourceType']).to eql('User')
 
           @u2.reload
@@ -571,13 +617,13 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
           expect_any_instance_of(MockUsersController).to receive(:update).once.and_call_original
           expect {
-            patch "/Users/#{@u2.id}", params: payload.merge(format: :scim)
+            patch "/Users/#{@u2.primary_key}", params: payload.merge(format: :scim)
           }.to_not change { MockUser.count }
 
           expect(response.status).to eql(200)
           result = JSON.parse(response.body)
 
-          expect(result['id']).to eql(@u2.id.to_s)
+          expect(result['id']).to eql(@u2.primary_key.to_s)
           expect(result['meta']['resourceType']).to eql('User')
 
           @u2.reload
@@ -601,7 +647,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
     it 'notes Rails validation failures' do
       expect {
-        patch "/Users/#{@u2.id}", params: {
+        patch "/Users/#{@u2.primary_key}", params: {
           format: :scim,
           Operations: [
             {
@@ -645,6 +691,142 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
       result = JSON.parse(response.body)
       expect(result['status']).to eql('404')
     end
+
+    context 'when removing users from groups' do
+      before :each do
+        @g1.mock_users << @u1
+        @g1.mock_users << @u2
+        @g1.mock_users << @u3
+
+        # (Self-check) Verify group representation
+        #
+        get "/Groups/#{@g1.id}", params: { format: :scim }
+
+        expect(response.status).to eql(200)
+        result = JSON.parse(response.body)
+
+        expect(result['members'].map { |m| m['value'] }.sort()).to eql(MockUser.pluck(:primary_key).sort())
+      end
+
+      it 'can remove all users' do
+        expect {
+          expect {
+            patch "/Groups/#{@g1.id}", params: {
+              format: :scim,
+              Operations: [
+                {
+                  op: 'remove',
+                  path: 'members'
+                }
+              ]
+            }
+          }.to_not change { MockUser.count }
+        }.to_not change { MockGroup.count }
+
+        get "/Groups/#{@g1.id}", params: { format: :scim }
+
+        expect(response.status).to eql(200)
+        result = JSON.parse(response.body)
+
+        expect(result['members']).to be_empty
+        expect(@g1.reload().mock_users).to be_empty
+      end
+
+      # Define via 'let':
+      #
+      # * Hash 'payload', to send via 'patch'
+      # * MockUser 'removed_user', which is the user that should be removed
+      #
+      shared_examples 'a user remover' do
+        it 'which removes the identified user' do
+          expect {
+            expect {
+              patch "/Groups/#{@g1.id}", params: payload()
+            }.to_not change { MockUser.count }
+          }.to_not change { MockGroup.count }
+
+          expected_remaining_user_ids = MockUser
+            .where.not(primary_key: removed_user().id)
+            .pluck(:primary_key)
+            .sort()
+
+          get "/Groups/#{@g1.id}", params: { format: :scim }
+
+          expect(response.status).to eql(200)
+          result = JSON.parse(response.body)
+
+          expect(result['members'].map { |m| m['value'] }.sort()).to eql(expected_remaining_user_ids)
+          expect(@g1.reload().mock_users.map(&:primary_key).sort()).to eql(expected_remaining_user_ids)
+        end
+      end
+
+      # https://www.rfc-editor.org/rfc/rfc7644#section-3.5.2.2
+      #
+      context 'and using an RFC-compliant payload' do
+        let(:removed_user) { @u2 }
+        let(:payload) do
+          {
+            format: :scim,
+            Operations: [
+              {
+                op: 'remove',
+                path: "members[value eq \"#{removed_user().primary_key}\"]",
+              }
+            ]
+          }
+        end
+
+        it_behaves_like 'a user remover'
+      end # context 'and using an RFC-compliant payload' do
+
+      # https://learn.microsoft.com/en-us/azure/active-directory/app-provisioning/use-scim-to-provision-users-and-groups#update-group-remove-members
+      #
+      context 'and using a Microsoft variant payload' do
+        let(:removed_user) { @u2 }
+        let(:payload) do
+          {
+            format: :scim,
+            Operations: [
+              {
+                op: 'remove',
+                path: 'members',
+                value: [{
+                  '$ref' => nil,
+                  'value' => removed_user().primary_key
+                }]
+              }
+            ]
+          }
+        end
+
+        it_behaves_like 'a user remover'
+      end # context 'and using a Microsoft variant payload' do
+
+      # https://help.salesforce.com/s/articleView?id=sf.identity_scim_manage_groups.htm&type=5
+      #
+      context 'and using a Salesforce variant payload' do
+        let(:removed_user) { @u2 }
+        let(:payload) do
+          {
+            format: :scim,
+            Operations: [
+              {
+                op: 'remove',
+                path: 'members',
+                value: {
+                  'members' => [{
+                    '$ref' => nil,
+                    'value' => removed_user().primary_key
+                  }]
+                }
+              }
+            ]
+          }
+        end
+
+        it_behaves_like 'a user remover'
+      end # context 'and using a Salesforce variant payload' do
+    end # "context 'when removing users from groups' do"
   end # "context '#update' do"
 
   # ===========================================================================
@@ -654,7 +836,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
       expect_any_instance_of(MockUsersController).to receive(:destroy).once.and_call_original
       expect_any_instance_of(MockUser).to receive(:destroy!).once.and_call_original
       expect {
-        delete "/Users/#{@u2.id}", params: { format: :scim }
+        delete "/Users/#{@u2.primary_key}", params: { format: :scim }
       }.to change { MockUser.count }.by(-1)
 
       expect(response.status).to eql(204)
@@ -666,7 +848,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
       expect_any_instance_of(MockUser).to_not receive(:destroy!)
 
       expect {
-        delete "/CustomDestroyUsers/#{@u2.id}", params: { format: :scim }
+        delete "/CustomDestroyUsers/#{@u2.primary_key}", params: { format: :scim }
       }.to_not change { MockUser.count }
 
       expect(response.status).to eql(204)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scimitar
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - RIPA Global
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -211,7 +211,6 @@ files:
 - spec/apps/dummy/db/migrate/20210304014602_create_mock_users.rb
 - spec/apps/dummy/db/migrate/20210308020313_create_mock_groups.rb
 - spec/apps/dummy/db/migrate/20210308044214_create_join_table_mock_groups_mock_users.rb
-- spec/apps/dummy/db/migrate/20230109012729_add_timestamps_to_mock_user.rb
 - spec/apps/dummy/db/schema.rb
 - spec/controllers/scimitar/application_controller_spec.rb
 - spec/controllers/scimitar/resource_types_controller_spec.rb
@@ -261,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.4
 signing_key:
 specification_version: 4
 summary: SCIM v2 for Rails
@@ -283,7 +282,6 @@ test_files:
 - spec/apps/dummy/db/migrate/20210304014602_create_mock_users.rb
 - spec/apps/dummy/db/migrate/20210308020313_create_mock_groups.rb
 - spec/apps/dummy/db/migrate/20210308044214_create_join_table_mock_groups_mock_users.rb
-- spec/apps/dummy/db/migrate/20230109012729_add_timestamps_to_mock_user.rb
 - spec/apps/dummy/db/schema.rb
 - spec/controllers/scimitar/application_controller_spec.rb
 - spec/controllers/scimitar/resource_types_controller_spec.rb

data/spec/apps/dummy/db/migrate/20230109012729_add_timestamps_to_mock_user.rb

@@ -1,5 +0,0 @@
-class AddTimestampsToMockUser < ActiveRecord::Migration[7.0]
-  def change
-    add_timestamps :mock_users
-  end
-end