scimitar 2.7.1 → 2.7.3

data/spec/requests/active_record_backed_resources_controller_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
     ids = 3.times.map { SecureRandom.uuid }.sort()
 
     @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)
+    @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, password: 'oldpassword')
     @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')
@@ -345,6 +345,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
           attributes = {
             userName: '4',
+            password: 'correcthorsebatterystaple',
             name: {
               givenName: 'Given',
               familyName: 'Family'
@@ -379,6 +380,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
           expect(result['id']).to eql(new_mock.id.to_s)
           expect(result['meta']['resourceType']).to eql('User')
           expect(new_mock.username).to eql('4')
+          expect(new_mock.password).to eql('correcthorsebatterystaple')
           expect(new_mock.first_name).to eql('Given')
           expect(new_mock.last_name).to eql('Family')
           expect(new_mock.home_email_address).to eql('home_4@test.com')
@@ -523,14 +525,14 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
   context '#replace' do
     shared_examples 'a replacer' do | force_upper_case: |
       it 'which replaces all attributes in an instance' do
-        attributes = { userName: '4' }  # Minimum required by schema
+        attributes = { userName: '4' } # Minimum required by schema
         attributes = spec_helper_hupcase(attributes) if force_upper_case
 
         # Prove that certain known pathways are called; can then unit test
         # those if need be and be sure that this covers #replace actions.
         #
         expect_any_instance_of(MockUsersController).to receive(:replace).once.and_call_original
-        expect_any_instance_of(MockUsersController).to receive(:save! ).once.and_call_original
+        expect_any_instance_of(MockUsersController).to receive(:save!  ).once.and_call_original
         expect {
           put "/Users/#{@u2.primary_key}", params: attributes.merge(format: :scim)
         }.to_not change { MockUser.count }
@@ -543,12 +545,44 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         expect(result['id']).to eql(@u2.primary_key.to_s)
         expect(result['meta']['resourceType']).to eql('User')
 
+        expect(result).to     have_key('name')
+        expect(result).to_not have_key('password')
+
         @u2.reload
 
         expect(@u2.username).to eql('4')
         expect(@u2.first_name).to be_nil
         expect(@u2.last_name).to be_nil
         expect(@u2.home_email_address).to be_nil
+        expect(@u2.password).to be_nil
+      end
+
+      it 'can replace passwords' do
+        attributes = { userName: '4', password: 'correcthorsebatterystaple' }
+        attributes = spec_helper_hupcase(attributes) if force_upper_case
+
+        expect {
+          put "/Users/#{@u2.primary_key}", params: attributes.merge(format: :scim)
+        }.to_not change { MockUser.count }
+
+        expect(response.status                 ).to eql(200)
+        expect(response.headers['Content-Type']).to eql('application/scim+json; charset=utf-8')
+
+        result = JSON.parse(response.body)
+
+        expect(result['id']).to eql(@u2.primary_key.to_s)
+        expect(result['meta']['resourceType']).to eql('User')
+
+        expect(result).to     have_key('name')
+        expect(result).to_not have_key('password')
+
+        @u2.reload
+
+        expect(@u2.username).to eql('4')
+        expect(@u2.first_name).to be_nil
+        expect(@u2.last_name).to be_nil
+        expect(@u2.home_email_address).to be_nil
+        expect(@u2.password).to eql('correcthorsebatterystaple')
       end
     end # "shared_examples 'a replacer' do | force_upper_case: |"
 
@@ -626,7 +660,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
     context 'with a block' do
       it 'invokes the block' do
-        attributes = { userName: '4' }  # Minimum required by schema
+        attributes = { userName: '4' } # Minimum required by schema
 
         expect_any_instance_of(CustomReplaceMockUsersController).to receive(:replace).once.and_call_original
         expect {
@@ -681,7 +715,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
   context '#update' do
     shared_examples 'an updater' do | force_upper_case: |
-      it 'which patches specific attributes' do
+      it 'which patches regular attributes' do
         payload = {
           Operations: [
             {
@@ -717,6 +751,9 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         expect(result['id']).to eql(@u2.primary_key.to_s)
         expect(result['meta']['resourceType']).to eql('User')
 
+        expect(result).to     have_key('name')
+        expect(result).to_not have_key('password')
+
         @u2.reload
 
         expect(@u2.username).to eql('4')
@@ -724,6 +761,145 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         expect(@u2.last_name).to eql('Bar')
         expect(@u2.home_email_address).to eql('home_2@test.com')
         expect(@u2.work_email_address).to eql('work_4@test.com')
+        expect(@u2.password).to eql('oldpassword')
+      end
+
+      context 'which' do
+        shared_examples 'it handles not-to-spec in-value Azure/Entra dotted attribute paths' do | operation |
+          it "and performs operation" do
+            payload = {
+              Operations: [
+                {
+                  op: 'add',
+                  value: {
+                    'name.givenName'  => 'Foo!',
+                    'name.familyName' => 'Bar!',
+                    'name.formatted'  => 'Foo! Bar!' # Unrecognised; should be ignored
+                  },
+                },
+              ]
+            }
+
+            payload = spec_helper_hupcase(payload) if force_upper_case
+            patch "/Users/#{@u2.primary_key}", params: payload.merge(format: :scim)
+
+            expect(response.status                 ).to eql(200)
+            expect(response.headers['Content-Type']).to eql('application/scim+json; charset=utf-8')
+
+            @u2.reload
+            result = JSON.parse(response.body)
+
+            expect(@u2.first_name).to eql('Foo!')
+            expect(@u2.last_name ).to eql('Bar!')
+          end
+        end
+
+        it_behaves_like 'it handles not-to-spec in-value Azure/Entra dotted attribute paths', 'add'
+        it_behaves_like 'it handles not-to-spec in-value Azure/Entra dotted attribute paths', 'replace'
+
+        shared_examples 'it handles schema ID value keys without inline attributes' do | operation |
+          it "and performs operation" do
+            payload = {
+              Operations: [
+                {
+                  op: operation,
+                  value: {
+                    'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User': {
+                      'organization' => 'Foo Bar!',
+                      'department'   => 'Bar Foo!'
+                    },
+                  },
+                },
+              ]
+            }
+
+            @u2.update!(organization: 'Old org')
+            payload = spec_helper_hupcase(payload) if force_upper_case
+            patch "/Users/#{@u2.primary_key}", params: payload.merge(format: :scim)
+
+            expect(response.status                 ).to eql(200)
+            expect(response.headers['Content-Type']).to eql('application/scim+json; charset=utf-8')
+
+            @u2.reload
+            result = JSON.parse(response.body)
+
+            expect(@u2.organization).to eql('Foo Bar!')
+            expect(@u2.department  ).to eql('Bar Foo!')
+          end
+        end
+
+        it_behaves_like 'it handles schema ID value keys without inline attributes', 'add'
+        it_behaves_like 'it handles schema ID value keys without inline attributes', 'replace'
+
+        shared_examples 'it handles schema ID value keys with inline attributes' do
+          it "and performs operation" do
+            payload = {
+              Operations: [
+                {
+                  op: 'add',
+                  value: {
+                    'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization' => 'Foo Bar!',
+                    'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department'   => 'Bar Foo!'
+                  },
+                },
+              ]
+            }
+
+            @u2.update!(organization: 'Old org')
+            payload = spec_helper_hupcase(payload) if force_upper_case
+            patch "/Users/#{@u2.primary_key}", params: payload.merge(format: :scim)
+
+            expect(response.status                 ).to eql(200)
+            expect(response.headers['Content-Type']).to eql('application/scim+json; charset=utf-8')
+
+            @u2.reload
+            result = JSON.parse(response.body)
+
+            expect(@u2.organization).to eql('Foo Bar!')
+            expect(@u2.department  ).to eql('Bar Foo!')
+          end
+        end
+
+        it_behaves_like 'it handles schema ID value keys with inline attributes', 'add'
+        it_behaves_like 'it handles schema ID value keys with inline attributes', 'replace'
+      end
+
+      it 'which patches "returned: \'never\'" fields' do
+        payload = {
+          Operations: [
+            {
+              op: 'replace',
+              path: 'password',
+              value: 'correcthorsebatterystaple'
+            }
+          ]
+        }
+
+        payload = spec_helper_hupcase(payload) if force_upper_case
+
+        expect {
+          patch "/Users/#{@u2.primary_key}", params: payload.merge(format: :scim)
+        }.to_not change { MockUser.count }
+
+        expect(response.status                 ).to eql(200)
+        expect(response.headers['Content-Type']).to eql('application/scim+json; charset=utf-8')
+
+        result = JSON.parse(response.body)
+
+        expect(result['id']).to eql(@u2.primary_key.to_s)
+        expect(result['meta']['resourceType']).to eql('User')
+
+        expect(result).to     have_key('name')
+        expect(result).to_not have_key('password')
+
+        @u2.reload
+
+        expect(@u2.username).to eql('2')
+        expect(@u2.first_name).to eql('Foo')
+        expect(@u2.last_name).to eql('Bar')
+        expect(@u2.home_email_address).to eql('home_2@test.com')
+        expect(@u2.work_email_address).to be_nil
+        expect(@u2.password).to eql('correcthorsebatterystaple')
       end
 
       context 'which clears attributes' do

data/spec/support/hash_with_indifferent_case_insensitive_access_spec.rb

@@ -37,6 +37,114 @@ RSpec.describe Scimitar::Support::HashWithIndifferentCaseInsensitiveAccess do
         expect(subject()).to_not have_key('bar')
       end
     end # "context 'where keys set as symbols' do"
+
+    context 'access and merging' do
+      before :each do
+        @original_subject = subject().to_h().dup()
+      end
+
+      it 'returns keys as Strings' do
+        subject()[:foo] = 1
+        subject()[:BAR] = 2
+
+        expect(subject().keys).to match_array(@original_subject.keys + ['foo', 'BAR'])
+      end
+
+      it 'retains original case of keys' do
+        subject()[:foo ] = 1
+        subject()['FoO'] = 40 # (first-time-set case preservation test in passing)
+        subject()[:BAR ] = 2
+        subject()['Baz'] = 3
+
+        expectation = @original_subject.merge({
+          'foo' => 40,
+          'BAR' => 2,
+          'Baz' => 3
+        })
+
+        expect(subject()).to eql(expectation)
+      end
+
+      it '#merge does not mutate the receiver and retains case of first-set keys' do
+        subject()[:foo] = 1
+        subject()[:BAR] = 2
+
+        pre_merge_subject = subject().dup()
+
+        result      = subject().merge({:FOO => { 'onE' => 40 }, :Baz => 3})
+        expectation = @original_subject.merge({
+          'foo' => { 'onE' => 40 },
+          'BAR' => 2,
+          'Baz' => 3
+        })
+
+        expect(subject()).to eql(pre_merge_subject)
+        expect(result).to eql(expectation)
+      end
+
+      it '#merge! mutates the receiver retains case of first-set keys' do
+        subject()[:foo] = 1
+        subject()[:BAR] = 2
+
+        subject().merge!({:FOO => { 'onE' => 40 }, :Baz => 3})
+
+        expectation = @original_subject.merge({
+          'foo' => { 'onE' => 40 },
+          'BAR' => 2,
+          'Baz' => 3
+        })
+
+        expect(subject()).to eql(expectation)
+      end
+
+      it '#deep_merge does not mutate the receiver and retains nested key cases' do
+        subject()[:foo] = { :one => 10 }
+        subject()[:BAR] = 2
+
+        pre_merge_subject = subject().dup()
+
+        result      = subject().deep_merge({:FOO => { 'ONE' => 40, :TWO => 20 }, :Baz => 3})
+        expectation = @original_subject.merge({
+          'foo' => { 'one' => 40, 'TWO' => 20 },
+          'BAR' => 2,
+          'Baz' => 3
+        })
+
+        expect(subject()).to eql(pre_merge_subject)
+        expect(result).to eql(expectation)
+      end
+
+      it '#deep_merge! mutates the receiver and retains nested key cases' do
+        subject()[:foo] = { :one => 10 }
+        subject()[:BAR] = 2
+
+        subject().deep_merge!({:FOO => { 'ONE' => 40, :TWO => 20 }, :Baz => 3})
+
+        expectation = @original_subject.merge({
+          'foo' => { 'one' => 40, 'TWO' => 20 },
+          'BAR' => 2,
+          'Baz' => 3
+        })
+
+        expect(subject()).to eql(expectation)
+      end
+
+      it 'retains indifferent behaviour after duplication' do
+        subject()[:foo] = { 'onE' => 40 }
+        subject()[:BAR] = 2
+
+        duplicate = subject().dup()
+        duplicate.merge!({ 'FOO' => true, 'baz' => 3 })
+
+        expectation = @original_subject.merge({
+          'foo' => true,
+          'BAR' => 2,
+          'baz' => 3
+        })
+
+        expect(duplicate.to_h).to eql(expectation.to_h)
+      end
+    end # "context 'access and merging' do"
   end # "shared_examples 'an indifferent access, case insensitive Hash' do"
 
   context 'when created directly' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scimitar
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.7.3
 platform: ruby
 authors:
 - RIPA Global
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails