scimitar 2.1.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d10a10d763c621e797fbe343a113a8610f9317a06455f177c60c42062663b4da
-  data.tar.gz: 251c1b73b7dd51ded63d85f7b0816163a9bd567099db9ce5f57e4929301d7a49
+  metadata.gz: 68d1c5d2f9f2b72a4582a04d6430b6fd7fd62ffc3fcdfe39422f2159acdcd3e1
+  data.tar.gz: 23a4d69326377dc1e68d3e1ff09d17a3adbc0e922bee7be6289acec2c4d790e4
 SHA512:
-  metadata.gz: 77accce401fb9f6fbb91a0ebf53294754286867cc2becce4f8acccbbd35f90c9062174d1da0e0ad4c80a92acc053c4a0b30898260fe95dc580bf3df33453f975
-  data.tar.gz: 9e64bad4582b54c988f612f9a0920b291431a79f62f9656bcad2658c5a0ded291e9cf96f47cac5f2b130c47a30edbf3b68b6f8abe96ca9cb8a7bb8dcaea83bd2
+  metadata.gz: 98e7ececc69633a18c3e4f1b946f586959177223317a050edf8e1e8a916727f18f01e6cfb1103ff31a65c890708e6c85c41d42478636c9a4924efa99817b4a98
+  data.tar.gz: 9674932b834c16f8176340bfa826ebac4d06e6aade8c561c484f1031877f6803ef732210b43ed0613972fe44aeb98707a429a1f5a87388909c1a0694cdfe9f98

data/app/controllers/scimitar/active_record_backed_resources_controller.rb

@@ -37,6 +37,7 @@ module Scimitar
       pagination_info = scim_pagination_info(query.count())
 
       page_of_results = query
+        .order(id: :asc)
         .offset(pagination_info.offset)
         .limit(pagination_info.limit)
         .to_a()

data/app/controllers/scimitar/application_controller.rb

@@ -25,8 +25,8 @@ module Scimitar
       #
       # ...to "globally" invoke this handler if you wish.
       #
-      # +_exception+:: Exception instance, used for a configured error reporter
-      #                via #handle_scim_error (if present).
+      # +exception+:: Exception instance, used for a configured error reporter
+      #               via #handle_scim_error (if present).
       #
       def handle_resource_not_found(exception)
         handle_scim_error(NotFoundError.new(params[:id]), exception)

data/app/models/scimitar/error_response.rb

@@ -17,7 +17,7 @@ module Scimitar
       data
     end
 
-    # From v1, Scimitar used attribute "detail" for the exception text; it was
+    # Originally Scimitar used attribute "detail" for exception text; it was
     # only for JSON responses at the time, but in hindsight was a bad choice.
     # It should have been "message" given inheritance from StandardError, which
     # then works properly with e.g. error reporting services.

data/app/models/scimitar/lists/query_parser.rb

@@ -78,7 +78,7 @@ module Scimitar
       #                   method's return value here.
       #
       def initialize(attribute_map)
-        @attribute_map = attribute_map
+        @attribute_map = attribute_map.with_indifferent_case_insensitive_access()
       end
 
       # Parse SCIM filter query into RPN stack
@@ -605,6 +605,16 @@ module Scimitar
 
           raise Scimitar::FilterError unless all_supported
 
+          unless case_sensitive
+            lc_scim_attribute = scim_attribute.downcase()
+
+            case_sensitive = (
+              lc_scim_attribute == 'id' ||
+              lc_scim_attribute == 'externalid' ||
+              lc_scim_attribute.start_with?('meta.')
+            )
+          end
+
           column_names.each.with_index do | column_name, index |
             arel_column    = arel_table[column_name]
             arel_operation = case scim_operator

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

@@ -902,7 +902,11 @@ module Scimitar
                     altering_hash[path_component] = value
                   end
                 when 'replace'
-                  altering_hash[path_component] = value
+                  if path_component == 'root'
+                    altering_hash[path_component].merge!(value)
+                  else
+                    altering_hash[path_component] = value
+                  end
                 when 'remove'
                   altering_hash.delete(path_component)
               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.1.0'
+  VERSION = '2.1.3'
 
   # Date for VERSION. If this changes, be sure to re-run "bundle install"
   # or "bundle update".
   #
-  DATE = '2022-07-14'
+  DATE = '2023-01-09'
 
 end

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

@@ -92,11 +92,14 @@ class MockUser < ActiveRecord::Base
 
   def self.scim_queryable_attributes
     return {
-      'name.givenName'  => { column: :first_name },
-      'name.familyName' => { column: :last_name  },
-      'emails'          => { columns: [ :work_email_address, :home_email_address ] },
-      'emails.value'    => { columns: [ :work_email_address, :home_email_address ] },
-      'emails.type'     => { ignore: true } # We can't filter on that; it'll just search all e-mails
+      'id'                => { column: :id },
+      'externalId'        => { column: :scim_uid },
+      'meta.lastModified' => { column: :updated_at },
+      'name.givenName'    => { column: :first_name },
+      'name.familyName'   => { column: :last_name  },
+      'emails'            => { columns: [ :work_email_address, :home_email_address ] },
+      'emails.value'      => { columns: [ :work_email_address, :home_email_address ] },
+      'emails.type'       => { ignore: true } # We can't filter on that; it'll just search all e-mails
     }
   end
 

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

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

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

@@ -10,8 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2021_03_08_044214) do
-
+ActiveRecord::Schema[7.0].define(version: 2023_01_09_012729) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
@@ -37,6 +36,8 @@ ActiveRecord::Schema.define(version: 2021_03_08_044214) do
     t.text "work_email_address"
     t.text "home_email_address"
     t.text "work_phone_number"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
 end

data/spec/controllers/scimitar/application_controller_spec.rb

@@ -208,7 +208,11 @@ RSpec.describe Scimitar::ApplicationController do
       context 'and bad JSON' do
         controller do
           def index
-            raise ActionDispatch::Http::Parameters::ParseError.new("Hello")
+            begin
+              raise 'Hello'
+            rescue
+              raise ActionDispatch::Http::Parameters::ParseError
+            end
           end
         end
 

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

@@ -590,7 +590,7 @@ RSpec.describe Scimitar::Lists::QueryParser do
       end
 
       it 'complains if there is no column mapping available' do
-        expect { @instance.send(:activerecord_columns, 'externalId') }.to raise_error(Scimitar::FilterError)
+        expect { @instance.send(:activerecord_columns, 'userName') }.to raise_error(Scimitar::FilterError)
       end
 
       it 'complains about malformed declarations' do

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

@@ -1747,6 +1747,24 @@ RSpec.describe Scimitar::Resources::Mixin do
                 expect(scim_hash['emails'][0]['type' ]).to eql('work')
                 expect(scim_hash['emails'][0]['value']).to eql('work@test.com')
               end
+
+              context 'when prior value already exists, and no path' do
+                it 'simple value: overwrites' do
+                  path      = [ 'root' ]
+                  scim_hash = { 'root' => { 'userName' => 'bar', 'active' => true } }.with_indifferent_case_insensitive_access()
+
+                  @instance.send(
+                    :from_patch_backend!,
+                    nature:        'replace',
+                    path:          path,
+                    value:         { 'active' => false }.with_indifferent_case_insensitive_access(),
+                    altering_hash: scim_hash
+                  )
+
+                  expect(scim_hash['root']['userName']).to eql('bar')
+                  expect(scim_hash['root']['active']).to eql(false)
+                end
+              end
             end # context 'when value is not present' do
           end # "context 'replace' do"
 

data/spec/models/scimitar/schema/attribute_spec.rb

@@ -21,10 +21,8 @@ RSpec.describe Scimitar::Schema::Attribute do
       expect(name.type).to eql('complex')
       expect(name.subAttributes).to eql(Scimitar::Schema::Name.scim_attributes)
     end
-
   end
 
-
   context '#valid?' do
     it 'is invalid if attribute is required but value is blank' do
       attribute = described_class.new(name: 'userName', type: 'string', required: true)
@@ -76,5 +74,4 @@ RSpec.describe Scimitar::Schema::Attribute do
       expect(described_class.new(name: 'startDate', type: 'dateTime').valid?('gaga')).to be(false)
     end
   end
-
 end

data/spec/requests/active_record_backed_resources_controller_spec.rb

@@ -1,12 +1,15 @@
 require 'spec_helper'
+require 'time'
 
 RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
   before :each do
     allow_any_instance_of(Scimitar::ApplicationController).to receive(:authenticated?).and_return(true)
 
-    @u1 = MockUser.create(username: '1', first_name: 'Foo', last_name: 'Ark', home_email_address: 'home_1@test.com')
-    @u2 = MockUser.create(username: '2', first_name: 'Foo', last_name: 'Bar', home_email_address: 'home_2@test.com')
-    @u3 = MockUser.create(username: '3', first_name: 'Foo',                   home_email_address: 'home_3@test.com')
+    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)
   end
 
   # ===========================================================================
@@ -48,7 +51,7 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
       it 'applies a filter, with case-insensitive value comparison' do
         get '/Users', params: {
           format: :scim,
-          filter: 'name.givenName eq "Foo" and name.familyName pr and emails ne "home_1@TEST.COM"'
+          filter: 'name.givenName eq "FOO" and name.familyName pr and emails ne "home_1@test.com"'
         }
 
         expect(response.status).to eql(200)
@@ -64,6 +67,87 @@ RSpec.describe Scimitar::ActiveRecordBackedResourcesController do
         expect(usernames).to match_array(['2'])
       end
 
+      it 'applies a filter, with case-insensitive attribute matching (GitHub issue #37)' do
+        get '/Users', params: {
+          format: :scim,
+          filter: 'name.GIVENNAME eq "Foo" and name.Familyname pr and emails ne "home_1@test.com"'
+        }
+
+        expect(response.status).to eql(200)
+        result = JSON.parse(response.body)
+
+        expect(result['totalResults']).to eql(1)
+        expect(result['Resources'].size).to eql(1)
+
+        ids = result['Resources'].map { |resource| resource['id'] }
+        expect(ids).to match_array([@u2.id.to_s])
+
+        usernames = result['Resources'].map { |resource| resource['userName'] }
+        expect(usernames).to match_array(['2'])
+      end
+
+      # Strange attribute capitalisation in tests here builds on test coverage
+      # for now-fixed GitHub issue #37.
+      #
+      context '"meta" / IDs (GitHub issue #36)' 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}\""
+          }
+
+          expect(response.status).to eql(200)
+          result = JSON.parse(response.body)
+
+          expect(result['totalResults']).to eql(1)
+          expect(result['Resources'].size).to eql(1)
+
+          ids = result['Resources'].map { |resource| resource['id'] }
+          expect(ids).to match_array([@u3.id.to_s])
+
+          usernames = result['Resources'].map { |resource| resource['userName'] }
+          expect(usernames).to match_array(['3'])
+        end
+
+        it 'applies a filter on external IDs, using direct comparison' do
+          get '/Users', params: {
+            format: :scim,
+            filter: "externalID eq \"#{@u2.scim_uid}\""
+          }
+
+          expect(response.status).to eql(200)
+          result = JSON.parse(response.body)
+
+          expect(result['totalResults']).to eql(1)
+          expect(result['Resources'].size).to eql(1)
+
+          ids = result['Resources'].map { |resource| resource['id'] }
+          expect(ids).to match_array([@u2.id.to_s])
+
+          usernames = result['Resources'].map { |resource| resource['userName'] }
+          expect(usernames).to match_array(['2'])
+        end
+
+        it 'applies a filter on "meta" entries, using direct comparison' do
+          get '/Users', params: {
+            format: :scim,
+            filter: "Meta.LastModified eq \"#{@u3.updated_at}\""
+          }
+
+          expect(response.status).to eql(200)
+          result = JSON.parse(response.body)
+
+          expect(result['totalResults']).to eql(1)
+          expect(result['Resources'].size).to eql(1)
+
+          ids = result['Resources'].map { |resource| resource['id'] }
+          expect(ids).to match_array([@u3.id.to_s])
+
+          usernames = result['Resources'].map { |resource| resource['userName'] }
+          expect(usernames).to match_array(['3'])
+        end
+      end # "context '"meta" / IDs (GitHub issue #36)' do"
+
       it 'obeys a page size' do
         get '/Users', params: {
           format: :scim,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scimitar
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.3
 platform: ruby
 authors:
 - RIPA Global
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -211,6 +211,7 @@ 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
@@ -260,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: SCIM v2 for Rails
@@ -282,6 +283,7 @@ 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