scimitar 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4361be0d5f54ce11106a22215c7ec4167a877961dc775908e902f3c6abc281e
-  data.tar.gz: b4e721e5f247b4ed1f3fa1a65f0f68b4572bc4d41ad44a68d37578c41d71e718
+  metadata.gz: 95a2166cc921a400959f9d8d4398f6bf8ecb772f8d7a0a0a73950892e85d808a
+  data.tar.gz: cdf5aab3812f10f69c96304e738a150f4208850267527b66d36eeb99548d7b1f
 SHA512:
-  metadata.gz: f373036a611555190e8d15bfd021be1bda8dc3bd358d58dfc8825f656bcdd648a5b7b2c06e091c58455b7eadec6277ccbf58646dd2b26bc4f9864dd6aa2761e7
-  data.tar.gz: e05d6fd73646929393c7edfea91076bf475fb1f997be0692130a5ba12b2d0f56ee8e106f775b1cdabdf8ed8723d56042b4941c110f66ce800b6868336d6762f7
+  metadata.gz: f0925517599b107e44fd93db9be142aebe608892c2c5069c50d22b353c51238290710474b062a002fdb010be3d783c4dea3b314f72f47b4aca3c2385a8fc1377
+  data.tar.gz: eef6eebfc64bb2d4adabfca110f26e3a6c9e227f47387da6fb384925899ddf0ae260cf68176f24040a6bb356cf34f6576c920bd44264d4a1fee415aeadc237e6

data/app/models/scimitar/errors.rb

@@ -1,6 +1,6 @@
 module Scimitar
   module Errors
-    def add_errors_from_hash(errors_hash, prefix: nil)
+    def add_errors_from_hash(errors_hash:, prefix: nil)
       errors_hash.each_pair do |key, value|
         new_key = prefix.nil? ? key : "#{prefix}.#{key}".to_sym
         if value.is_a?(Array)

data/app/models/scimitar/schema/attribute.rb

@@ -88,7 +88,7 @@ module Scimitar
         end
         value.class.schema.valid?(value)
         return true if value.errors.empty?
-        add_errors_from_hash(value.errors.to_hash, prefix: self.name)
+        add_errors_from_hash(errors_hash: value.errors.to_hash, prefix: self.name)
         false
       end
 

data/app/models/scimitar/schema/base.rb

@@ -26,7 +26,9 @@ module Scimitar
       #
       def self.valid?(resource)
         cloned_scim_attributes.each do |scim_attribute|
-          resource.add_errors_from_hash(scim_attribute.errors.to_hash) unless scim_attribute.valid?(resource.send(scim_attribute.name))
+          unless scim_attribute.valid?(resource.send(scim_attribute.name))
+            resource.add_errors_from_hash(errors_hash: scim_attribute.errors.to_hash)
+          end
         end
       end
 

data/config/initializers/scimitar.rb

@@ -2,81 +2,85 @@
 #
 # For supporting information and rationale, please see README.md.
 
-# =============================================================================
-# SERVICE PROVIDER CONFIGURATION
-# =============================================================================
-#
-# This is a Ruby abstraction over a SCIM entity that declares the capabilities
-# supported by a particular implementation.
-#
-# Typically this is used to declare parts of the standard unsupported, if you
-# don't need them and don't want to provide subclass support.
-#
-Scimitar.service_provider_configuration = Scimitar::ServiceProviderConfiguration.new({
+Rails.application.config.to_prepare do # (required for >= Rails 7 / Zeitwerk)
 
-  # See https://tools.ietf.org/html/rfc7643#section-8.5 for properties.
+  # ===========================================================================
+  # SERVICE PROVIDER CONFIGURATION
+  # ===========================================================================
   #
-  # See Gem source file 'app/models/scimitar/service_provider_configuration.rb'
-  # for defaults. Define Hash keys here that override defaults; e.g. to declare
-  # that filters are not supported so that calling clients shouldn't use them:
+  # This is a Ruby abstraction over a SCIM entity that declares the
+  # capabilities supported by a particular implementation.
   #
-  #   filter: Scimitar::Supported.unsupported
+  # Typically this is used to declare parts of the standard unsupported, if you
+  # don't need them and don't want to provide subclass support.
+  #
+  Scimitar.service_provider_configuration = Scimitar::ServiceProviderConfiguration.new({
 
-})
+    # See https://tools.ietf.org/html/rfc7643#section-8.5 for properties.
+    #
+    # See Gem file 'app/models/scimitar/service_provider_configuration.rb'
+    # for defaults. Define Hash keys here that override defaults; e.g. to
+    # declare that filters are not supported so that calling clients shouldn't
+    # use them:
+    #
+    #   filter: Scimitar::Supported.unsupported
 
-# =============================================================================
-# ENGINE CONFIGURATION
-# =============================================================================
-#
-# This is where you provide callbacks for things like authorisation or mixins
-# that get included into all Scimitar-derived controllers (for things like
-# before-actions that apply to all Scimitar controller-based routes).
-#
-Scimitar.engine_configuration = Scimitar::EngineConfiguration.new({
+  })
 
-  # If you have filters you want to run for any Scimitar action/route, you can
-  # define them here. For example, you might use a before-action to set up some
-  # multi-tenancy related state, or skip Rails CSRF token verification/
-  #
-  # For example:
+  # ===========================================================================
+  # ENGINE CONFIGURATION
+  # ===========================================================================
   #
-  #     application_controller_mixin: Module.new do
-  #       def self.included(base)
-  #         base.class_eval do
+  # This is where you provide callbacks for things like authorisation or mixins
+  # that get included into all Scimitar-derived controllers (for things like
+  # before-actions that apply to all Scimitar controller-based routes).
   #
-  #           # Anything here is written just as you'd write it at the top of
-  #           # one of your controller classes, but it gets included in all
-  #           # Scimitar classes too.
-  #
-  #           skip_before_action    :verify_authenticity_token
-  #           prepend_before_action :setup_some_kind_of_multi_tenancy_data
-  #         end
-  #       end
-  #     end, # ...other configuration entries might follow...
+  Scimitar.engine_configuration = Scimitar::EngineConfiguration.new({
 
-  # If you want to support username/password authentication:
-  #
-  #     basic_authenticator: Proc.new do | username, password |
-  #       # Check username/password and return 'true' if valid, else 'false'.
-  #     end, # ...other configuration entries might follow...
-  #
-  # The 'username' and 'password' parameters come from Rails:
-  #
-  #   https://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Basic.html
-  #   https://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Basic/ControllerMethods.html#method-i-authenticate_with_http_basic
+    # If you have filters you want to run for any Scimitar action/route, you
+    # can define them here. For example, you might use a before-action to set
+    # up some multi-tenancy related state, or skip Rails CSRF token
+    # verification. For example:
+    #
+    #     application_controller_mixin: Module.new do
+    #       def self.included(base)
+    #         base.class_eval do
+    #
+    #           # Anything here is written just as you'd write it at the top of
+    #           # one of your controller classes, but it gets included in all
+    #           # Scimitar classes too.
+    #
+    #           skip_before_action    :verify_authenticity_token
+    #           prepend_before_action :setup_some_kind_of_multi_tenancy_data
+    #         end
+    #       end
+    #     end, # ...other configuration entries might follow...
 
-  # If you want to support HTTP bearer token (OAuth-style) authentication:
-  #
-  #     token_authenticator: Proc.new do | token, options |
-  #       # Check token and return 'true' if valid, else 'false'.
-  #     end, # ...other configuration entries might follow...
-  #
-  # The 'token' and 'options' parameters come from Rails:
-  #
-  #   https://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Token.html
-  #   https://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Token/ControllerMethods.html#method-i-authenticate_with_http_token
-  #
-  # Note that both basic and token authentication can be declared, with the
-  # parameters in the inbound HTTP request determining which is invoked.
+    # If you want to support username/password authentication:
+    #
+    #     basic_authenticator: Proc.new do | username, password |
+    #       # Check username/password and return 'true' if valid, else 'false'.
+    #     end, # ...other configuration entries might follow...
+    #
+    # The 'username' and 'password' parameters come from Rails:
+    #
+    #   https://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Basic.html
+    #   https://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Basic/ControllerMethods.html#method-i-authenticate_with_http_basic
+
+    # If you want to support HTTP bearer token (OAuth-style) authentication:
+    #
+    #     token_authenticator: Proc.new do | token, options |
+    #       # Check token and return 'true' if valid, else 'false'.
+    #     end, # ...other configuration entries might follow...
+    #
+    # The 'token' and 'options' parameters come from Rails:
+    #
+    #   https://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Token.html
+    #   https://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Token/ControllerMethods.html#method-i-authenticate_with_http_token
+    #
+    # Note that both basic and token authentication can be declared, with the
+    # parameters in the inbound HTTP request determining which is invoked.
+
+  })
 
-})
+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.2.0'
+  VERSION = '2.0.0'
 
   # Date for VERSION. If this changes, be sure to re-run "bundle install"
   # or "bundle update".
   #
-  DATE = '2021-09-27'
+  DATE = '2022-03-04'
 
 end

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

@@ -12,6 +12,7 @@ require 'scimitar'
 
 module Dummy
   class Application < Rails::Application
+    config.load_defaults 7.0
   end
 end
 

data/spec/apps/dummy/config/environments/test.rb

@@ -1,15 +1,38 @@
+require 'active_support/core_ext/integer/time'
+
 Rails.application.configure do
   config.cache_classes = true
   config.eager_load = false
-  config.serve_static_files = true
-  config.static_cache_control = 'public, max-age=3600'
-  config.consider_all_requests_local = true
 
-  config.action_dispatch.show_exceptions = false
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => "public, max-age=#{1.hour.to_i}"
+  }
 
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
+  config.cache_store = :null_store
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false
 
-  config.active_support.test_order = :random
+  # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raises error for missing translations.
+  config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
 end

data/spec/apps/dummy/config/initializers/scimitar.rb

@@ -1,14 +1,16 @@
 # Test app configuration.
 #
-Scimitar.engine_configuration = Scimitar::EngineConfiguration.new({
+Rails.application.config.to_prepare do
+  Scimitar.engine_configuration = Scimitar::EngineConfiguration.new({
 
-  application_controller_mixin: Module.new do
-    def self.included(base)
-      base.class_eval do
-        def test_hook; end
-        before_action :test_hook
+    application_controller_mixin: Module.new do
+      def self.included(base)
+        base.class_eval do
+          def test_hook; end
+          before_action :test_hook
+        end
       end
     end
-  end
 
-})
+  })
+end

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

@@ -42,25 +42,25 @@ 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(errors_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(errors_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
 
     it 'adds the error with prefix when the value is a string' do
-      user.add_errors_from_hash({key: 'some error'}, prefix: :pre)
+      user.add_errors_from_hash(errors_hash: {key: 'some error'}, prefix: :pre)
       expect(user.errors.messages.to_h).to eql({:'pre.key' => ['some error']})
       expect(user.errors.full_messages).to eql(['Pre key some error'])
     end
 
     it 'adds the error wity prefix when the value is an array' do
-      user.add_errors_from_hash({key: ['error1', 'error2']}, prefix: :pre)
+      user.add_errors_from_hash(errors_hash: {key: ['error1', 'error2']}, prefix: :pre)
       expect(user.errors.messages.to_h).to eql({:'pre.key' => ['error1', 'error2']})
       expect(user.errors.full_messages).to eql(['Pre key error1', 'Pre key error2'])
     end

data/spec/requests/application_controller_spec.rb

@@ -23,7 +23,6 @@ RSpec.describe Scimitar::ApplicationController do
 
       expect(response).to have_http_status(:bad_request)
       expect(JSON.parse(response.body)['detail']).to start_with('Invalid JSON - ')
-      expect(JSON.parse(response.body)['detail']).to include("'not-json-12345'")
     end
 
     it 'translates Content-Type to Rails request format' do

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: scimitar
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - RIPA Global
 - Andrew David Hodgkinson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '6.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -245,7 +245,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -260,51 +260,51 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
-signing_key: 
+rubygems_version: 3.3.3
+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/20210304014602_create_mock_users.rb