scimitar 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 382f2feb979c655de91c1d30bf1fa8bb5347059abe376839758a9b34992f8616
-  data.tar.gz: d1d8f8c32a92f4b879699a995b4e1746b7b778d782ab3101695e59891a107606
+  metadata.gz: cd0efbdecece6297062b46cf46bdeaccd8330cd58fc94fb2bcb0de7c7bb90806
+  data.tar.gz: 7f3528ee080f0f295d03c77fba1586484b5cadd6ef5e4de1fc00d7807ec7a0c1
 SHA512:
-  metadata.gz: 87373dddf17fe6791e7464c228e688338267bf1a230cd2ab1d69372185ea3adcf165b969872e0e05556ba28b1e9e1581ddaac5639f89235bd7f19da081ff3e7f
-  data.tar.gz: ae79056e07500c1b195807a9a3f12755895f47a4383c7451208a2956b79ec02e600a8c915fa8a600cccce559c16b5c62f73e081ced2e09e8bee5da63910a2a1e
+  metadata.gz: 8044cc09d7b964401b09e6fe8ccfa272b6c67ab97687c79a151010a447109f9e671bb864094905b2495100591e2472f673ce2b977fc07f2a13213a8d4fbc75b1
+  data.tar.gz: 51a5522fcf948d3b9f19c6bc5b28732f0fb4537034106d47dca83d7d043d5749d9adf1c31acf10fc7eb79a63739787a0ec42f0a261eb293072634aabca0ec92d

data/app/controllers/scimitar/active_record_backed_resources_controller.rb

@@ -21,6 +21,8 @@ module Scimitar
 
     rescue_from ActiveRecord::RecordNotFound, with: :handle_resource_not_found # See Scimitar::ApplicationController
 
+    before_action :obtain_id_column_name_from_attribute_map
+
     # GET (list)
     #
     def index
@@ -37,13 +39,13 @@ module Scimitar
       pagination_info = scim_pagination_info(query.count())
 
       page_of_results = query
-        .order(id: :asc)
+        .order(@id_column => :asc)
         .offset(pagination_info.offset)
         .limit(pagination_info.limit)
         .to_a()
 
       super(pagination_info, page_of_results) do | record |
-        record.to_scim(location: url_for(action: :show, id: record.id))
+        record_to_scim(record)
       end
     end
 
@@ -52,7 +54,7 @@ module Scimitar
     def show
       super do |record_id|
         record = self.find_record(record_id)
-        record.to_scim(location: url_for(action: :show, id: record_id))
+        record_to_scim(record)
       end
     end
 
@@ -64,7 +66,7 @@ module Scimitar
           record = self.storage_class().new
           record.from_scim!(scim_hash: scim_resource.as_json())
           self.save!(record)
-          record.to_scim(location: url_for(action: :show, id: record.id))
+          record_to_scim(record)
         end
       end
     end
@@ -77,7 +79,7 @@ module Scimitar
           record = self.find_record(record_id)
           record.from_scim!(scim_hash: scim_resource.as_json())
           self.save!(record)
-          record.to_scim(location: url_for(action: :show, id: record.id))
+          record_to_scim(record)
         end
       end
     end
@@ -90,7 +92,7 @@ module Scimitar
           record = self.find_record(record_id)
           record.from_scim_patch!(patch_hash: patch_hash)
           self.save!(record)
-          record.to_scim(location: url_for(action: :show, id: record.id))
+          record_to_scim(record)
         end
       end
     end
@@ -138,7 +140,14 @@ module Scimitar
       # +record_id+:: Record ID (SCIM schema 'id' value - "our" ID).
       #
       def find_record(record_id)
-        self.storage_scope().find(record_id)
+        self.storage_scope().find_by!(@id_column => record_id)
+      end
+
+      # DRY up controller actions - pass a record; returns the SCIM
+      # representation, with a "show" location specified via #url_for.
+      #
+      def record_to_scim(record)
+        record.to_scim(location: url_for(action: :show, id: record.send(@id_column)))
       end
 
       # Save a record, dealing with validation exceptions by raising SCIM
@@ -177,5 +186,16 @@ module Scimitar
         end
       end
 
+      # Called via +before_action+ - stores in @id_column the name of whatever
+      # model column is used to store the record ID, via
+      # Scimitar::Resources::Mixin::scim_attributes_map.
+      #
+      # Default is <tt>:id</tt>.
+      #
+      def obtain_id_column_name_from_attribute_map
+        attrs      = storage_class().scim_attributes_map() || {}
+        @id_column = attrs[:id] || :id
+      end
+
   end
 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 = '1.3.3'
+  VERSION = '1.4.0'
 
   # Date for VERSION. If this changes, be sure to re-run "bundle install"
   # or "bundle update".
   #
-  DATE = '2023-01-10'
+  DATE = '2023-01-26'
 
 end

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

@@ -1,4 +1,4 @@
-class MockUsersController < Scimitar::ActiveRecordBackedResourcesController
+class MockGroupsController < Scimitar::ActiveRecordBackedResourcesController
 
   protected
 

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

@@ -58,7 +58,7 @@ class MockGroup < ActiveRecord::Base
 
           case type.downcase
             when 'user'
-              MockUser.find_by_id(id)
+              MockUser.find_by_primary_key(id)
             when 'group'
               MockGroup.find_by_id(id)
             else

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

@@ -5,7 +5,7 @@ class MockUser < ActiveRecord::Base
   # ===========================================================================
 
   READWRITE_ATTRS = %w{
-    id
+    primary_key
     scim_uid
     username
     first_name
@@ -38,7 +38,7 @@ class MockUser < ActiveRecord::Base
 
   def self.scim_attributes_map
     return {
-      id:         :id,
+      id:         :primary_key,
       externalId: :scim_uid,
       userName:   :username,
       name:       {
@@ -92,7 +92,7 @@ class MockUser < ActiveRecord::Base
 
   def self.scim_queryable_attributes
     return {
-      'id'                => { column: :id },
+      'id'                => { column: :primary_key },
       'externalId'        => { column: :scim_uid },
       'meta.lastModified' => { column: :updated_at },
       'name.givenName'    => { column: :first_name },

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

@@ -13,6 +13,9 @@ Rails.application.routes.draw do
   patch  'Users/:id', to: 'mock_users#update'
   delete 'Users/:id', to: 'mock_users#destroy'
 
+  get    'Groups',     to: 'mock_groups#index'
+  get    'Groups/:id', to: 'mock_groups#show'
+
   # For testing blocks passed to ActiveRecordBackedResourcesController#destroy
   #
   delete 'CustomDestroyUsers/:id', to: 'custom_destroy_mock_users#destroy'

data/spec/apps/dummy/db/migrate/20210304014602_create_mock_users.rb

@@ -1,6 +1,7 @@
 class CreateMockUsers < ActiveRecord::Migration[6.1]
   def change
-    create_table :mock_users do |t|
+    create_table :mock_users, id: :uuid, primary_key: :primary_key do |t|
+      t.timestamps
 
       t.text :scim_uid
       t.text :username
@@ -9,7 +10,6 @@ class CreateMockUsers < ActiveRecord::Migration[6.1]
       t.text :work_email_address
       t.text :home_email_address
       t.text :work_phone_number
-
     end
   end
 end

data/spec/apps/dummy/db/migrate/20210308044214_create_join_table_mock_groups_mock_users.rb

@@ -1,8 +1,13 @@
 class CreateJoinTableMockGroupsMockUsers < ActiveRecord::Migration[6.1]
   def change
-    create_join_table :mock_groups, :mock_users do |t|
-      t.index [:mock_group_id, :mock_user_id]
-      t.index [:mock_user_id, :mock_group_id]
+    create_table :mock_groups_users, id: false do | t |
+      t.references :mock_group, foreign_key: true, type: :int8, index: true, null: false
+      t.references :mock_user,                     type: :uuid, index: true, null: false, primary_key: :primary_key
+
+      # The 'foreign_key:' option (used above) only works for 'id' column names
+      # but the test data has a column named 'primary_key' for 'mock_users'.
+      #
+      t.foreign_key :mock_users, primary_key: :primary_key
     end
   end
 end

data/spec/apps/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2023_01_09_012729) do
+ActiveRecord::Schema.define(version: 2021_03_08_044214) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -24,12 +24,14 @@ ActiveRecord::Schema.define(version: 2023_01_09_012729) do
 
   create_table "mock_groups_users", id: false, force: :cascade do |t|
     t.bigint "mock_group_id", null: false
-    t.bigint "mock_user_id", null: false
-    t.index ["mock_group_id", "mock_user_id"], name: "index_mock_groups_users_on_mock_group_id_and_mock_user_id"
-    t.index ["mock_user_id", "mock_group_id"], name: "index_mock_groups_users_on_mock_user_id_and_mock_group_id"
+    t.uuid "mock_user_id", null: false
+    t.index ["mock_group_id"], name: "index_mock_groups_users_on_mock_group_id"
+    t.index ["mock_user_id"], name: "index_mock_groups_users_on_mock_user_id"
   end
 
-  create_table "mock_users", force: :cascade do |t|
+  create_table "mock_users", primary_key: "primary_key", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
     t.text "scim_uid"
     t.text "username"
     t.text "first_name"
@@ -37,8 +39,8 @@ ActiveRecord::Schema.define(version: 2023_01_09_012729) do
     t.text "work_email_address"
     t.text "home_email_address"
     t.text "work_phone_number"
-    t.datetime "created_at", precision: 6, null: false
-    t.datetime "updated_at", precision: 6, null: false
   end
 
+  add_foreign_key "mock_groups_users", "mock_groups"
+  add_foreign_key "mock_groups_users", "mock_users", primary_key: "primary_key"
 end

data/spec/models/scimitar/lists/query_parser_spec.rb

@@ -405,19 +405,19 @@ RSpec.describe Scimitar::Lists::QueryParser do
       query = @instance.to_activerecord_query(MockUser.all)
 
       expect(query.count).to eql(1)
-      expect(query.pluck(:id)).to eql([user_1.id])
+      expect(query.pluck(:primary_key)).to eql([user_1.id])
 
       @instance.parse('name.givenName sw J') # First name starts with 'J'
       query = @instance.to_activerecord_query(MockUser.all)
 
       expect(query.count).to eql(2)
-      expect(query.pluck(:id)).to match_array([user_1.id, user_2.id])
+      expect(query.pluck(:primary_key)).to match_array([user_1.primary_key, user_2.primary_key])
 
       @instance.parse('name.familyName ew he') # Last name ends with 'he'
       query = @instance.to_activerecord_query(MockUser.all)
 
       expect(query.count).to eql(1)
-      expect(query.pluck(:id)).to eql([user_2.id])
+      expect(query.pluck(:primary_key)).to eql([user_2.primary_key])
 
       # Test presence
 
@@ -425,7 +425,7 @@ RSpec.describe Scimitar::Lists::QueryParser do
       query = @instance.to_activerecord_query(MockUser.all)
 
       expect(query.count).to eql(2)
-      expect(query.pluck(:id)).to match_array([user_1.id, user_2.id])
+      expect(query.pluck(:primary_key)).to match_array([user_1.primary_key, user_2.primary_key])
 
       # Test a simple not-equals, but use a custom starting scope. Note that
       # the query would find "user_3" *except* there is no first name defined
@@ -435,7 +435,7 @@ RSpec.describe Scimitar::Lists::QueryParser do
       query = @instance.to_activerecord_query(MockUser.where.not('first_name' => 'John'))
 
       expect(query.count).to eql(1)
-      expect(query.pluck(:id)).to match_array([user_1.id])
+      expect(query.pluck(:primary_key)).to match_array([user_1.primary_key])
     end
 
     context 'when mapped to multiple columns' do
@@ -499,7 +499,7 @@ RSpec.describe Scimitar::Lists::QueryParser do
           query = @instance.to_activerecord_query(MockUser.all)
 
           expect(query.count).to eql(1)
-          expect(query.pluck(:id)).to match_array([user_2.id])
+          expect(query.pluck(:primary_key)).to match_array([user_2.primary_key])
         end
       end # "context 'simple AND' do"
 
@@ -520,7 +520,7 @@ RSpec.describe Scimitar::Lists::QueryParser do
           query = @instance.to_activerecord_query(MockUser.all)
 
           expect(query.count).to eql(2)
-          expect(query.pluck(:id)).to match_array([user_1.id, user_2.id])
+          expect(query.pluck(:primary_key)).to match_array([user_1.primary_key, user_2.primary_key])
         end
       end # "context 'simple OR' do"
 
@@ -546,7 +546,7 @@ RSpec.describe Scimitar::Lists::QueryParser do
           query = @instance.to_activerecord_query(MockUser.all)
 
           expect(query.count).to eql(3)
-          expect(query.pluck(:id)).to match_array([user_1.id, user_2.id, user_3.id])
+          expect(query.pluck(:primary_key)).to match_array([user_1.primary_key, user_2.primary_key, user_3.primary_key])
         end
       end # "context 'combined AND and OR' do"
 

data/spec/models/scimitar/resources/mixin_spec.rb

@@ -159,41 +159,67 @@ RSpec.describe Scimitar::Resources::Mixin do
     # =========================================================================
 
     context '#to_scim' do
-      it 'compiles instance attribute values into a SCIM representation' do
-        instance                    = MockUser.new
-        instance.id                 = 42
-        instance.scim_uid           = 'AA02984'
-        instance.username           = 'foo'
-        instance.first_name         = 'Foo'
-        instance.last_name          = 'Bar'
-        instance.work_email_address = 'foo.bar@test.com'
-        instance.home_email_address = nil
-        instance.work_phone_number  = '+642201234567'
-
-        g1 = MockGroup.create!(display_name: 'Group 1')
-        g2 = MockGroup.create!(display_name: 'Group 2')
-        g3 = MockGroup.create!(display_name: 'Group 3')
-
-        g1.mock_users << instance
-        g3.mock_users << instance
-
-        scim = instance.to_scim(location: 'https://test.com/mock_users/42')
-        json = scim.to_json()
-        hash = JSON.parse(json)
-
-        expect(hash).to eql({
-          'userName'    => 'foo',
-          'name'        => {'givenName'=>'Foo', 'familyName'=>'Bar'},
-          'active'      => true,
-          'emails'      => [{'type'=>'work', 'primary'=>true, 'value'=>'foo.bar@test.com'}, {"primary"=>false, "type"=>"home", "value"=>nil}],
-          'phoneNumbers'=> [{'type'=>'work', 'primary'=>false, 'value'=>'+642201234567'}],
-          'id'          => '42', # Note, String
-          'externalId'  => 'AA02984',
-          'groups'      => [{'display'=>g1.display_name, 'value'=>g1.id.to_s}, {'display'=>g3.display_name, 'value'=>g3.id.to_s}],
-          'meta'        => {'location'=>'https://test.com/mock_users/42', 'resourceType'=>'User'},
-          'schemas'     => ['urn:ietf:params:scim:schemas:core:2.0:User']
-        })
-      end
+      context 'with a UUID, renamed primary key column' do
+        it 'compiles instance attribute values into a SCIM representation' do
+          uuid                        = SecureRandom.uuid
+
+          instance                    = MockUser.new
+          instance.primary_key        = uuid
+          instance.scim_uid           = 'AA02984'
+          instance.username           = 'foo'
+          instance.first_name         = 'Foo'
+          instance.last_name          = 'Bar'
+          instance.work_email_address = 'foo.bar@test.com'
+          instance.home_email_address = nil
+          instance.work_phone_number  = '+642201234567'
+
+          g1 = MockGroup.create!(display_name: 'Group 1')
+          g2 = MockGroup.create!(display_name: 'Group 2')
+          g3 = MockGroup.create!(display_name: 'Group 3')
+
+          g1.mock_users << instance
+          g3.mock_users << instance
+
+          scim = instance.to_scim(location: "https://test.com/mock_users/#{uuid}")
+          json = scim.to_json()
+          hash = JSON.parse(json)
+
+          expect(hash).to eql({
+            'userName'    => 'foo',
+            'name'        => {'givenName'=>'Foo', 'familyName'=>'Bar'},
+            'active'      => true,
+            'emails'      => [{'type'=>'work', 'primary'=>true, 'value'=>'foo.bar@test.com'}, {"primary"=>false, "type"=>"home", "value"=>nil}],
+            'phoneNumbers'=> [{'type'=>'work', 'primary'=>false, 'value'=>'+642201234567'}],
+            'id'          => uuid,
+            'externalId'  => 'AA02984',
+            'groups'      => [{'display'=>g1.display_name, 'value'=>g1.id.to_s}, {'display'=>g3.display_name, 'value'=>g3.id.to_s}],
+            'meta'        => {'location'=>"https://test.com/mock_users/#{uuid}", 'resourceType'=>'User'},
+            'schemas'     => ['urn:ietf:params:scim:schemas:core:2.0:User']
+          })
+        end
+      end # "context 'with a UUID, renamed primary key column' do"
+
+      context 'with an integer, conventionally named primary key column' do
+        it 'compiles instance attribute values into a SCIM representation' do
+          instance              = MockGroup.new
+          instance.id           = 42
+          instance.scim_uid     = 'GG02984'
+          instance.display_name = 'Some group'
+
+          scim = instance.to_scim(location: 'https://test.com/mock_groups/42')
+          json = scim.to_json()
+          hash = JSON.parse(json)
+
+          expect(hash).to eql({
+            'displayName' => 'Some group',
+            'id'          => '42', # Note, String
+            'externalId'  => 'GG02984',
+            'members'     => [],
+            'meta'        => {'location'=>'https://test.com/mock_groups/42', 'resourceType'=>'Group'},
+            'schemas'     => ['urn:ietf:params:scim:schemas:core:2.0:Group']
+          })
+        end
+      end # "context 'with an integer, conventionally named primary key column' do"
 
       context 'with optional timestamps' do
         context 'creation only' do
@@ -405,8 +431,8 @@ RSpec.describe Scimitar::Resources::Mixin do
               'displayName' => 'Foo Group',
               'members'     => [
                 {'type' => 'Group', 'value' => g1.id.to_s},
-                {'type' => 'User',  'value' => u1.id.to_s},
-                {'type' => 'User',  'value' => u3.id.to_s}
+                {'type' => 'User',  'value' => u1.primary_key.to_s},
+                {'type' => 'User',  'value' => u3.primary_key.to_s}
               ],
               'externalId'  => 'GG01536',
               'meta'        => {'location'=>'https://test.com/mock_groups/1', 'resourceType'=>'Group'},
@@ -453,8 +479,10 @@ RSpec.describe Scimitar::Resources::Mixin do
       end # "context 'using upper case' do"
 
       it 'clears things not present in input' do
+        uuid                        = SecureRandom.uuid
+
         instance                    = MockUser.new
-        instance.id                 = 42
+        instance.primary_key        = uuid
         instance.scim_uid           = 'AA02984'
         instance.username           = 'foo'
         instance.first_name         = 'Foo'
@@ -465,7 +493,7 @@ RSpec.describe Scimitar::Resources::Mixin do
 
         instance.from_scim!(scim_hash: {})
 
-        expect(instance.id                ).to eql(42)
+        expect(instance.primary_key       ).to eql(uuid)
         expect(instance.scim_uid          ).to be_nil
         expect(instance.username          ).to be_nil
         expect(instance.first_name        ).to be_nil

data/spec/models/scimitar/resources/user_spec.rb

@@ -42,13 +42,13 @@ RSpec.describe Scimitar::Resources::User do
     let(:user) { described_class.new }
 
     it 'adds the error when the value is a string' do
-      user.add_errors_from_hash(key: 'some error')
+      user.add_errors_from_hash({key: 'some error'})
       expect(user.errors.messages.to_h).to eql({key: ['some error']})
       expect(user.errors.full_messages).to eql(['Key some error'])
     end
 
     it 'adds the error when the value is an array' do
-      user.add_errors_from_hash(key: ['error1', 'error2'])
+      user.add_errors_from_hash({key: ['error1', 'error2']})
       expect(user.errors.messages.to_h).to eql({key: ['error1', 'error2']})
       expect(user.errors.full_messages).to eql(['Key error1', 'Key error2'])
     end

data/spec/requests/active_record_backed_resources_controller_spec.rb

@@ -7,9 +7,21 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
 
     lmt = Time.parse("2023-01-09 14:25:00 +1300")
 
-    @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)
+    # 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(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 +44,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 +93,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 +112,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 +125,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 +135,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 +154,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 +173,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 +193,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 +212,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 +236,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 }
@@ -248,7 +296,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
@@ -289,7 +337,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')
           expect(new_mock.first_name).to eql('Given')
@@ -363,13 +411,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 +439,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 +518,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 +555,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 +587,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 +619,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 +649,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: [
             {
@@ -654,7 +702,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 +714,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: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - RIPA Global
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-01-26 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,52 +260,51 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.4
 signing_key:
 specification_version: 4
 summary: SCIM v2 for Rails
 test_files:
-- spec/spec_helper.rb
-- spec/models/scimitar/lists/query_parser_spec.rb
+- spec/apps/dummy/app/controllers/custom_destroy_mock_users_controller.rb
+- spec/apps/dummy/app/controllers/custom_request_verifiers_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_user.rb
+- spec/apps/dummy/config/application.rb
+- spec/apps/dummy/config/boot.rb
+- spec/apps/dummy/config/environment.rb
+- spec/apps/dummy/config/environments/test.rb
+- spec/apps/dummy/config/initializers/cookies_serializer.rb
+- spec/apps/dummy/config/initializers/scimitar.rb
+- spec/apps/dummy/config/initializers/session_store.rb
+- spec/apps/dummy/config/routes.rb
+- 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/schema.rb
+- spec/controllers/scimitar/application_controller_spec.rb
+- spec/controllers/scimitar/resource_types_controller_spec.rb
+- spec/controllers/scimitar/resources_controller_spec.rb
+- spec/controllers/scimitar/schemas_controller_spec.rb
+- spec/controllers/scimitar/service_provider_configurations_controller_spec.rb
+- spec/models/scimitar/complex_types/address_spec.rb
+- spec/models/scimitar/complex_types/email_spec.rb
 - spec/models/scimitar/lists/count_spec.rb
+- spec/models/scimitar/lists/query_parser_spec.rb
+- spec/models/scimitar/resource_type_spec.rb
+- spec/models/scimitar/resources/base_spec.rb
 - spec/models/scimitar/resources/base_validation_spec.rb
 - spec/models/scimitar/resources/mixin_spec.rb
 - spec/models/scimitar/resources/user_spec.rb
-- spec/models/scimitar/resources/base_spec.rb
 - spec/models/scimitar/schema/attribute_spec.rb
+- spec/models/scimitar/schema/base_spec.rb
 - spec/models/scimitar/schema/group_spec.rb
 - spec/models/scimitar/schema/user_spec.rb
-- spec/models/scimitar/schema/base_spec.rb
-- spec/models/scimitar/resource_type_spec.rb
-- spec/models/scimitar/complex_types/email_spec.rb
-- spec/models/scimitar/complex_types/address_spec.rb
-- spec/requests/controller_configuration_spec.rb
-- spec/requests/engine_spec.rb
 - spec/requests/active_record_backed_resources_controller_spec.rb
 - spec/requests/application_controller_spec.rb
+- spec/requests/controller_configuration_spec.rb
+- spec/requests/engine_spec.rb
+- spec/spec_helper.rb
 - spec/spec_helper_spec.rb
 - spec/support/hash_with_indifferent_case_insensitive_access_spec.rb
-- spec/controllers/scimitar/schemas_controller_spec.rb
-- spec/controllers/scimitar/resource_types_controller_spec.rb
-- spec/controllers/scimitar/resources_controller_spec.rb
-- spec/controllers/scimitar/service_provider_configurations_controller_spec.rb
-- spec/controllers/scimitar/application_controller_spec.rb
-- spec/apps/dummy/app/models/mock_group.rb
-- spec/apps/dummy/app/models/mock_user.rb
-- spec/apps/dummy/app/controllers/custom_request_verifiers_controller.rb
-- spec/apps/dummy/app/controllers/custom_destroy_mock_users_controller.rb
-- spec/apps/dummy/app/controllers/mock_groups_controller.rb
-- spec/apps/dummy/app/controllers/mock_users_controller.rb
-- spec/apps/dummy/config/routes.rb
-- spec/apps/dummy/config/environments/test.rb
-- spec/apps/dummy/config/environment.rb
-- spec/apps/dummy/config/application.rb
-- spec/apps/dummy/config/boot.rb
-- spec/apps/dummy/config/initializers/session_store.rb
-- spec/apps/dummy/config/initializers/cookies_serializer.rb
-- spec/apps/dummy/config/initializers/scimitar.rb
-- spec/apps/dummy/db/schema.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/migrate/20210304014602_create_mock_users.rb

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

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