scimitar 2.5.0 → 2.11.0

data/spec/requests/engine_spec.rb

@@ -42,4 +42,79 @@ RSpec.describe Scimitar::Engine do
       expect(JSON.parse(response.body)['name']['familyName']).to eql('baz')
     end
   end # "context 'parameter parser' do"
+
+  # These are unit tests rather than request tests; seems like a reasonable
+  # place to put them in the absence of a standardised RSpec "engine" location.
+  #
+  context 'engine unit tests' do
+    around :each do | example |
+      license_schema = Class.new(Scimitar::Schema::Base) do
+        def initialize(options = {})
+          super(name: 'License', id: self.class.id(), description: 'Represents a License')
+        end
+        def self.id; 'urn:ietf:params:scim:schemas:license'; end
+        def self.scim_attributes; []; end
+      end
+
+      @license_resource = Class.new(Scimitar::Resources::Base) do
+        self.set_schema(license_schema)
+        def self.endpoint; '/License'; end
+      end
+
+      example.run()
+    ensure
+      Scimitar::Engine.reset_default_resources()
+      Scimitar::Engine.reset_custom_resources()
+    end
+
+    context '::resources, :add_custom_resource, ::set_default_resources' do
+      it 'returns default resources' do
+        expect(Scimitar::Engine.resources()).to match_array([Scimitar::Resources::User, Scimitar::Resources::Group])
+      end
+
+      it 'includes custom resources' do
+        Scimitar::Engine.add_custom_resource(@license_resource)
+        expect(Scimitar::Engine.resources()).to match_array([Scimitar::Resources::User, Scimitar::Resources::Group, @license_resource])
+      end
+
+      it 'notes changes to defaults' do
+        Scimitar::Engine.set_default_resources([Scimitar::Resources::User])
+        expect(Scimitar::Engine.resources()).to match_array([Scimitar::Resources::User])
+      end
+
+      it 'notes changes to defaults with custom resources added' do
+        Scimitar::Engine.set_default_resources([Scimitar::Resources::User])
+        Scimitar::Engine.add_custom_resource(@license_resource)
+        expect(Scimitar::Engine.resources()).to match_array([Scimitar::Resources::User, @license_resource])
+      end
+
+      it 'rejects bad defaults' do
+        expect {
+          Scimitar::Engine.set_default_resources([@license_resource])
+        }.to raise_error('Scimitar::Engine.set_default_resources: Only Scimitar::Resources::User, Scimitar::Resources::Group are supported')
+      end
+
+      it 'rejects empty defaults' do
+        expect {
+          Scimitar::Engine.set_default_resources([])
+        }.to raise_error('Scimitar::Engine.set_default_resources: At least one resource must be given')
+      end
+    end # "context '::resources, :add_custom_resource, ::set_default_resources' do"
+
+    context '#schemas' do
+      it 'returns schema instances from ::resources' do
+        expect(Scimitar::Engine).to receive(:resources).and_return([Scimitar::Resources::User, @license_resource])
+
+        schema_instances = Scimitar::Engine.schemas()
+        schema_classes   = schema_instances.map(&:class)
+
+        expect(schema_classes).to match_array([
+          Scimitar::Schema::User,
+          ScimSchemaExtensions::User::Enterprise,
+          ScimSchemaExtensions::User::Manager,
+          @license_resource.schemas.first
+        ])
+      end
+    end # "context '#schemas' do"
+  end # "context 'engine unit tests' do"
 end

data/spec/spec_helper.rb

@@ -19,7 +19,7 @@ require File.expand_path('../apps/dummy/config/environment', __FILE__)
 abort("The Rails environment is running in production mode!") if Rails.env.production?
 
 require 'rspec/rails'
-require 'byebug'
+require 'debug'
 require 'scimitar'
 
 # ============================================================================
@@ -30,14 +30,22 @@ RSpec.configure do | config |
   config.disable_monkey_patching!
   config.infer_spec_type_from_file_location!
   config.filter_rails_from_backtrace!
+  config.raise_errors_for_deprecations!
 
   config.color                      = true
   config.tty                        = true
   config.order                      = :random
-  config.fixture_path               = "#{::Rails.root}/spec/fixtures"
+  config.fixture_paths              = ["#{::Rails.root}/spec/fixtures"]
   config.use_transactional_fixtures = true
 
   Kernel.srand config.seed
+
+  config.around :each do | example |
+    original_engine_configuration = Scimitar.instance_variable_get('@engine_configuration')
+    example.run()
+  ensure
+    Scimitar.instance_variable_set('@engine_configuration', original_engine_configuration)
+  end
 end
 
 # ============================================================================

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,135 +1,136 @@
 --- !ruby/object:Gem::Specification
 name: scimitar
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.11.0
 platform: ruby
 authors:
 - RIPA Global
 - Andrew David Hodgkinson
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-25 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
-  name: simplecov-rcov
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.12'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: doggo
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 description: SCIM v2 support for Users and Groups in Ruby On Rails
 email:
-- dev@ripaglobal.com
+- ahodgkin@rowing.org.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - Rakefile
 - app/controllers/scimitar/active_record_backed_resources_controller.rb
 - app/controllers/scimitar/application_controller.rb
@@ -193,9 +194,14 @@ files:
 - lib/scimitar.rb
 - lib/scimitar/engine.rb
 - lib/scimitar/support/hash_with_indifferent_case_insensitive_access.rb
+- lib/scimitar/support/utilities.rb
 - lib/scimitar/version.rb
+- spec/apps/dummy/app/controllers/custom_create_mock_users_controller.rb
 - spec/apps/dummy/app/controllers/custom_destroy_mock_users_controller.rb
+- spec/apps/dummy/app/controllers/custom_replace_mock_users_controller.rb
 - 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_groups_controller.rb
 - spec/apps/dummy/app/controllers/mock_users_controller.rb
 - spec/apps/dummy/app/models/mock_group.rb
@@ -237,15 +243,14 @@ files:
 - spec/spec_helper.rb
 - spec/spec_helper_spec.rb
 - spec/support/hash_with_indifferent_case_insensitive_access_spec.rb
-homepage: https://www.ripaglobal.com/
+homepage: https://github.com/pond/scimitar/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://www.ripaglobal.com/
-  source_code_uri: https://github.com/RIPAGlobal/scimitar/
-  bug_tracker_uri: https://github.com/RIPAGlobal/scimitar/issues/
-  changelog_uri: https://github.com/RIPAGlobal/scimitar/blob/master/CHANGELOG.md
-post_install_message:
+  homepage_uri: https://github.com/pond/scimitar/
+  source_code_uri: https://github.com/pond/scimitar/
+  bug_tracker_uri: https://github.com/pond/scimitar/issues/
+  changelog_uri: https://github.com/pond/scimitar/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -260,13 +265,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.4
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: SCIM v2 for Rails
 test_files:
+- spec/apps/dummy/app/controllers/custom_create_mock_users_controller.rb
 - spec/apps/dummy/app/controllers/custom_destroy_mock_users_controller.rb
+- spec/apps/dummy/app/controllers/custom_replace_mock_users_controller.rb
 - 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_groups_controller.rb
 - spec/apps/dummy/app/controllers/mock_users_controller.rb
 - spec/apps/dummy/app/models/mock_group.rb