scimitar 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e8493f9f42ec39cc98639167c39e60261400208a011e21d202116d5ca43daff
-  data.tar.gz: fb1fe271b42006d0e0054207d873b18ad15851d76597bf78c591f2254eab6688
+  metadata.gz: 172c9b71a2da57bcc0b0ebc02c551a5ed8e70c7efda9fcbb01a6cea7b99f6c6b
+  data.tar.gz: 0d6fc7e2dcbe4fabcef481c197b96c6f757af8cc5f1ad8b5990a13c346d39517
 SHA512:
-  metadata.gz: 4f2d68d767cdf33d97684697466dbca05122783f6a081010f874ef8546cc684c3fe9ca8c72478c6214a7493ffc3d80dfd8a742d03c0748968a32b3dc76980e05
-  data.tar.gz: 456146fa9cd91c44208e689ba4ba5663626e4ba8bcd3fbdcd592e78785e5af63449d41e68c465e84f8567352a505d02a200b8fbca36b38b7a9d61bc7784b73b8
+  metadata.gz: 060e4aff1aa65516fef31e8c0403dfda82d2b015e990bcfed7b45e78830b8f545db30c8abe915126e4a760e62c4f5f34660b19b0d30f1815cc6575406961f9c4
+  data.tar.gz: 85659a28c38997bbb937fe153b48f77c4fe75f98d6c6dbad82006d8cd30d029db5f5e7e33e7fd614ee2630aba2ec558338d9de4e888be884fa11eb1159c261a4

data/README.md

@@ -123,7 +123,7 @@ Here's an example where Warden is being used for authentication, with Warden sto
 
 ```ruby
 Scimitar.engine_configuration = Scimitar::EngineConfiguration.new({
-  custome_authenticator: Proc.new do
+  custom_authenticator: Proc.new do
 
     # In this example we catch the Warden 'throw' for failed authentication, as
     # well as allowing Warden to successfully find an *authenticated* user, but
@@ -255,8 +255,8 @@ class User < ActiveRecord::Base
       ],
 
       # NB The 'groups' collection in a SCIM User resource is read-only, so
-      #    we provide no ":find_with" key for looking up records for writing
-      #    updates to the associated collection.
+      #    we provide no ":find_with" or ":find_all_with" key for looking up
+      #    records for writing updates to the associated collection.
       #
       groups: [
         {

data/app/controllers/scimitar/application_controller.rb

@@ -101,6 +101,9 @@ module Scimitar
           request.format = :scim
         elsif request.format == :scim
           request.headers['CONTENT_TYPE'] = scim_mime_type
+        elsif request.media_type.downcase == 'application/json' && request.user_agent.start_with?('Google') # https://github.com/pond/scimitar/issues/142
+          request.format = :scim
+          request.headers["CONTENT_TYPE"] = scim_mime_type
         else
           handle_scim_error(ErrorResponse.new(status: 406, detail: "Only #{scim_mime_type} type is accepted."))
         end

data/app/models/scimitar/resources/mixin.rb

@@ -145,7 +145,8 @@ module Scimitar
     #             display: :full_name  # <-- i.e. Team.users[n].full_name
     #           },
     #           class: Team, # Optional; see below
-    #           find_with: -> (scim_list_entry) {...} # See below
+    #           find_with:     -> (scim_list_entry) {...}, # See below
+    #           find_all_with: -> (scim_list_entries) {...} # Optional, See below
     #         }
     #       ],
     #       #...
@@ -165,6 +166,11 @@ module Scimitar
     # Scimitar::EngineConfiguration::schema_list_from_attribute_mappings is
     # defined; see documentation of that option for more information.
     #
+    # To avoid N+1 queries when resolving many entries (e.g. Group members
+    # during PATCH), you can instead provide ":find_all_with" which is passed
+    # the entire Array of SCIM entries and should return an Array of resolved
+    # model instances. If both are provided, ":find_all_with" is preferred.
+    #
     # Note that you can only use either:
     #
     # * One or more static maps where each matches some other piece of source
@@ -315,7 +321,7 @@ module Scimitar
                     enum.each do | static_or_dynamic_mapping |
                       if static_or_dynamic_mapping.key?(:match) # Static
                         extractor.call(static_or_dynamic_mapping[:using])
-                      elsif static_or_dynamic_mapping.key?(:find_with) # Dynamic
+                      elsif static_or_dynamic_mapping.key?(:find_with) || static_or_dynamic_mapping.key?(:find_all_with) # Dynamic
                         @scim_mutable_attributes << static_or_dynamic_mapping[:list]
                       end
                     end
@@ -839,9 +845,17 @@ module Scimitar
                     method    = "#{mapped_array_entry[:list]}="
 
                     if (attribute&.mutability == 'readWrite' || attribute&.mutability == 'writeOnly') && self.respond_to?(method)
-                      find_with_proc = mapped_array_entry[:find_with]
+                      find_all_with_proc = mapped_array_entry[:find_all_with]
+                      find_with_proc     = mapped_array_entry[:find_with]
+
+                      if find_all_with_proc.respond_to?(:call)
+                        scim_entries = (scim_hash_or_leaf_value || [])
+                        mapped_list  = find_all_with_proc.call(scim_entries) || []
 
-                      unless find_with_proc.nil?
+                        mapped_list.compact!
+
+                        self.public_send(method, mapped_list)
+                      elsif find_with_proc.respond_to?(:call)
                         mapped_list = (scim_hash_or_leaf_value || []).map do | source_list_entry |
                           find_with_proc.call(source_list_entry)
                         end

data/lib/scimitar/version.rb

@@ -3,11 +3,11 @@ module Scimitar
   # Gem version. If this changes, be sure to re-run "bundle install" or
   # "bundle update".
   #
-  VERSION = '2.12.0'
+  VERSION = '2.13.0'
 
   # Date for VERSION. If this changes, be sure to re-run "bundle install"
   # or "bundle update".
   #
-  DATE = '2025-08-15'
+  DATE = '2025-09-12'
 
 end

data/spec/apps/dummy/app/controllers/mock_batch_groups_controller.rb

@@ -0,0 +1,13 @@
+class MockBatchGroupsController < Scimitar::ActiveRecordBackedResourcesController
+
+  protected
+
+    def storage_class
+      MockGroupBatch
+    end
+
+    def storage_scope
+      MockGroupBatch.all
+    end
+
+end

data/spec/apps/dummy/app/models/mock_group_batch.rb

@@ -0,0 +1,20 @@
+class MockGroupBatch < MockGroup
+  def self.scim_attributes_map
+    {
+      id:          :id,
+      externalId:  :scim_uid,
+      displayName: :display_name,
+      members:     [
+        {
+          list:  :scim_users_and_groups,
+          using: { value: :id },
+          # Minimal mock: assume user-only entries (type omitted => User)
+          find_all_with: -> (entries) do
+            ids = entries.map { |e| e['value'] }
+            MockUser.where(primary_key: ids).to_a
+          end
+        }
+      ]
+    }
+  end
+end

data/spec/apps/dummy/config/routes.rb

@@ -17,6 +17,12 @@ Rails.application.routes.draw do
   get    'Groups/:id', to: 'mock_groups#show'
   patch  'Groups/:id', to: 'mock_groups#update'
 
+  # Batch lookup variant for testing the mixin 'find_all_with' option.
+  #
+  get    'BatchGroups',     to: 'mock_batch_groups#index'
+  get    'BatchGroups/:id', to: 'mock_batch_groups#show'
+  patch  'BatchGroups/:id', to: 'mock_batch_groups#update'
+
   # For testing blocks passed to ActiveRecordBackedResourcesController#create,
   # #update, #replace and #destroy.
   #

data/spec/controllers/scimitar/application_controller_spec.rb

@@ -416,6 +416,25 @@ RSpec.describe Scimitar::ApplicationController do
           expect(@exception.message).to eql('Only application/scim+json type is accepted.')
         end
       end
+
+      context 'and with Google SCIM calls' do
+        it 'reaches the controller action if the expected agent is making the request' do
+          request.headers['Content-Type'] = 'application/json'
+          request.headers['User-Agent'  ] = 'Google-Auto-Provisioning'
+          get :index
+
+          expect(@exception).to be_a(RuntimeError)
+          expect(@exception.message).to eql('Bang')
+        end
+
+        it 'is invoked early for unrecognised agents' do
+          request.headers['Content-Type'] = 'application/json'
+          get :index
+
+          expect(@exception).to be_a(Scimitar::ErrorResponse)
+          expect(@exception.message).to eql('Only application/scim+json type is accepted.')
+        end
+      end # "context 'and with Google SCIM calls' do"
     end # "context 'exception reporter' do"
   end # "context 'error handling' do"
 end

data/spec/requests/active_record_backed_resources_controller_spec.rb

@@ -1137,6 +1137,39 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         expect(@u2.password).to eql('correcthorsebatterystaple')
       end
 
+      context "when updating group members using :find_all_with" do
+        it "uses :find_all_with to batch-resolve users and updates associations" do
+          payload = {
+            schemas: [ 'urn:ietf:params:scim:api:messages:2.0:PatchOp' ],
+            Operations: [
+              {
+                op:   'add',
+                path: 'members',
+                value: [
+                  { 'value' => @u1.primary_key },
+                  { 'value' => @u2.primary_key }
+                ]
+              }
+            ]
+          }
+
+          payload = spec_helper_hupcase(payload) if force_upper_case
+
+          patch "/BatchGroups/#{@g1.id}", params: payload.merge({ format: :scim })
+
+          expect(response.status).to eql(200)
+
+          # Verify membership updated
+          get "/BatchGroups/#{@g1.id}", params: { format: :scim }
+          expect(response.status).to eql(200)
+          result = JSON.parse(response.body)
+
+          values = result.fetch('members', []).map { |m| m['value'] }
+          expect(values).to include(@u1.primary_key.to_s)
+          expect(values).to include(@u2.primary_key.to_s)
+        end
+      end
+
       context 'which clears attributes' do
         before :each do
           @u2.update!(work_email_address: 'work_2@test.com')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scimitar
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - RIPA Global
 - Andrew David Hodgkinson
 bindir: bin
 cert_chain: []
-date: 2025-08-15 00:00:00.000000000 Z
+date: 2025-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -230,9 +230,11 @@ files:
 - spec/apps/dummy/app/controllers/custom_request_verifiers_controller.rb
 - spec/apps/dummy/app/controllers/custom_save_mock_users_controller.rb
 - spec/apps/dummy/app/controllers/custom_update_mock_users_controller.rb
+- spec/apps/dummy/app/controllers/mock_batch_groups_controller.rb
 - spec/apps/dummy/app/controllers/mock_groups_controller.rb
 - spec/apps/dummy/app/controllers/mock_users_controller.rb
 - spec/apps/dummy/app/models/mock_group.rb
+- spec/apps/dummy/app/models/mock_group_batch.rb
 - spec/apps/dummy/app/models/mock_user.rb
 - spec/apps/dummy/config/application.rb
 - spec/apps/dummy/config/boot.rb
@@ -304,9 +306,11 @@ test_files:
 - spec/apps/dummy/app/controllers/custom_request_verifiers_controller.rb
 - spec/apps/dummy/app/controllers/custom_save_mock_users_controller.rb
 - spec/apps/dummy/app/controllers/custom_update_mock_users_controller.rb
+- spec/apps/dummy/app/controllers/mock_batch_groups_controller.rb
 - spec/apps/dummy/app/controllers/mock_groups_controller.rb
 - spec/apps/dummy/app/controllers/mock_users_controller.rb
 - spec/apps/dummy/app/models/mock_group.rb
+- spec/apps/dummy/app/models/mock_group_batch.rb
 - spec/apps/dummy/app/models/mock_user.rb
 - spec/apps/dummy/config/application.rb
 - spec/apps/dummy/config/boot.rb