scimitar 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '083949bb1e8b8d0afb8e62a87245a0f05189b05669e49eb8b5e3f8fa3af277e6'
-  data.tar.gz: 46a3f0af432f0980280ed8cc8f5c0309bc36f30c15673f9da650f8225f0f406d
+  metadata.gz: f2e3306d8e05674efa4a53f63e833304623187a3191ecd6ef5685ac03a3ae8a7
+  data.tar.gz: 346c86fe3728208d6e4afb6a2d684a2b46de6326549d1b5d3b1e96622f220dd4
 SHA512:
-  metadata.gz: 6d10c2377f023f1b3201148bd57813296b1746d64e738838410045a128a10c980ac675c3a7474b56848d2cfe97ab2421d07bfa1ada5512890bfa08bfa2556f82
-  data.tar.gz: 5ff25a1f64a5bccf0ee2289223d31f8bc6b8636586bf09f1903e0b5824aed483d0dba60d9f7736bdc20c5c71ef6858ab38529eee6ff2e00aae20d0b18cb5d647
+  metadata.gz: 723b88d08085f32e36caca03eceeee22c6653fb9b8fcbe94aa7c35aa6ae37f1de59fef29201ea42a00b4ec01540c3d77375c5d55ea07be4cee1447cdb3cc5e9f
+  data.tar.gz: 00e7ced581373571d0f086a0df9f18334b7b73ae6078ecd095edbfd2b5d7f5c6181515074bbbd49be3c8819531dbad9affa782a7f5087dec7d51a371c79646ea

data/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 RIPA Global
+Copyright (c) 2024 RIPA Global
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -321,7 +321,7 @@ end
 
 #### Other source types
 
-If you do _not_ use ActiveRecord to store data, or if you have very esoteric read-write requirements, you can subclass [`Scimigar::ResourcesController`](https://www.rubydoc.info/gems/scimitar/Scimitar/ResourcesController) in a manner similar to this:
+If you do _not_ use ActiveRecord to store data, or if you have very esoteric read-write requirements, you can subclass [`Scimitar::ResourcesController`](https://www.rubydoc.info/gems/scimitar/Scimitar/ResourcesController) in a manner similar to this:
 
 ```ruby
 class UsersController < Scimitar::ResourcesController
@@ -594,7 +594,7 @@ By default, Scimitar advertises (via things like [the `/Schemas` endpoint](https
 
 ```ruby
 Rails.application.config.to_prepare do
-  Scimitar::Engine::set_default_resources([Scimitar::Resources::User])
+  Scimitar::Engine.set_default_resources([Scimitar::Resources::User])
   # ...other Scimitar configuration / initialisation code...
 end
 ```

data/app/controllers/scimitar/application_controller.rb

@@ -9,10 +9,6 @@ module Scimitar
     before_action :add_mandatory_response_headers
     before_action :authenticate
 
-    if Scimitar.engine_configuration.application_controller_mixin
-      include Scimitar.engine_configuration.application_controller_mixin
-    end
-
     # =========================================================================
     # PROTECTED INSTANCE METHODS
     # =========================================================================
@@ -47,7 +43,7 @@ module Scimitar
       #
       # *exception+:: If a Ruby exception was the reason this method is being
       #               called, pass it here. Any configured exception reporting
-      #               mechanism will be invokved with the given parameter.
+      #               mechanism will be invoked with the given parameter.
       #               Otherwise, the +error_response+ value is reported.
       #
       def handle_scim_error(error_response, exception = error_response)
@@ -153,5 +149,8 @@ module Scimitar
         return result
       end
 
+    if Scimitar.engine_configuration.application_controller_mixin
+      include Scimitar.engine_configuration.application_controller_mixin
+    end
   end
 end

data/app/controllers/scimitar/resource_types_controller.rb

@@ -5,7 +5,13 @@ module Scimitar
         resource.resource_type(scim_resource_type_url(name: resource.resource_type_id))
       end
 
-      render json: resource_types
+      render json: {
+        schemas: [
+            'urn:ietf:params:scim:api:messages:2.0:ListResponse'
+        ],
+        totalResults: resource_types.size,
+        Resources:    resource_types
+      }
     end
 
     def show

data/app/controllers/scimitar/schemas_controller.rb

@@ -201,7 +201,7 @@ module Scimitar
             if mapped_multivalue_attribute.is_a?(Array)
 
               # A single-entry array with "list using" semantics, for a
-              # collection of an artbirary number of same-class items - e.g.
+              # collection of an arbitrary number of same-class items - e.g.
               # Groups to which a User belongs.
               #
               # If this is an up-to-date mapping, there's a "class" entry that

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

@@ -342,14 +342,14 @@ module Scimitar
           skip_next_component       = false
 
           components.each.with_index do | component, index |
-            if skip_next_component == true
+            if skip_next_component
               skip_next_component = false
               next
             end
 
             downcased = component.downcase.strip
 
-            if (expecting_attribute)
+            if expecting_attribute
               if downcased.match?(/[^\\]\[/) # Not backslash then literal '['
                 attribute_prefix       = component.match(/(.*?[^\\])\[/   )[1] # Everything before no-backslash-then-literal (unescaped) '['
                 first_attribute_inside = component.match(    /[^\\]\[(.*)/)[1] # Everything  after no-backslash-then-literal (unescaped) '['
@@ -362,7 +362,7 @@ module Scimitar
               expecting_attribute = false
               expecting_operator  = true
 
-            elsif (expecting_operator)
+            elsif expecting_operator
               rewritten << component
               if BINARY_OPERATORS.include?(downcased)
                 expecting_operator = false
@@ -374,7 +374,7 @@ module Scimitar
                 raise 'Expected operator'
               end
 
-            elsif (expecting_value)
+            elsif expecting_value
               matches = downcased.match(/([^\\])\](.*)/) # Contains no-backslash-then-literal (unescaped) ']'; also capture anything after
               unless matches.nil? # Contains no-backslash-then-literal (unescaped) ']'
                 character_before_closing_bracket = matches[1]
@@ -395,7 +395,7 @@ module Scimitar
                 # So - NOTE RECURSION AND EARLY EXIT POSSIBILITY HEREIN.
                 #
                 if (
-                  ! attribute_prefix.nil? &&
+                  !attribute_prefix.nil? &&
                   OPERATORS.key?(components[index + 1]&.downcase) &&
                   characters_after_closing_bracket.match?(/^\.#{ATTRNAME}$/)
                 )
@@ -437,7 +437,7 @@ module Scimitar
               if downcased.start_with?('"')
                 expecting_closing_quote = true
                 downcased = downcased[1..-1] # Strip off opening '"' to avoid false-positive on 'contains closing quote' check below
-              elsif expecting_closing_quote == false # If not expecting a closing quote, then the component must be the entire no-spaces value
+              elsif !expecting_closing_quote # If not expecting a closing quote, then the component must be the entire no-spaces value
                 expecting_value      = false
                 expecting_logic_word = true
               end
@@ -450,7 +450,7 @@ module Scimitar
                 end
               end
 
-            elsif (expecting_logic_word)
+            elsif expecting_logic_word
               if downcased == 'and' || downcased == 'or'
                 rewritten << component
                 next_downcased_component = components[index + 1].downcase.strip
@@ -586,11 +586,11 @@ module Scimitar
 
         # Recursively process an expression tree. Calls itself with nested tree
         # fragments. Each inner expression fragment calculates on the given
-        # base scope, with aggregration at each level into a wider query using
+        # base scope, with aggregation at each level into a wider query using
         # AND or OR depending on the expression tree contents.
         #
         # +base_scope+::      Base scope (ActiveRecord::Relation, e.g. User.all
-        #                     - neverchanges during recursion).
+        #                     - never changes during recursion).
         #
         # +expression_tree+:: Top-level expression tree or fragments inside if
         #                     self-calling recursively.
@@ -748,7 +748,7 @@ module Scimitar
 
         # Returns the mapped-to-your-domain column name(s) that a filter string
         # is operating upon, in an Array. If empty, the attribute is to be
-        # ignored. Raises an exception if entirey unmapped (thus unsupported).
+        # ignored. Raises an exception if entirely unmapped (thus unsupported).
         #
         # Note plural - the return value is always an array any of which should
         # be used (implicit 'OR').

data/app/models/scimitar/resource_type.rb

@@ -17,12 +17,10 @@ module Scimitar
 
     def as_json(options = {})
       without_extensions = super(except: 'schemaExtensions')
-      if schemaExtensions.present?
-        extensions = schemaExtensions.map{|extension| {"schema" => extension, "required" => false}}
-        without_extensions.merge('schemaExtensions' => extensions)
-      else
-        without_extensions
-      end
+      return without_extensions unless schemaExtensions.present? # NOTE EARLY EXIT
+
+      extensions = schemaExtensions.map{|extension| {"schema" => extension, "required" => false}}
+      without_extensions.merge('schemaExtensions' => extensions)
     end
 
   end

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

@@ -158,7 +158,7 @@ module Scimitar
         hash.with_indifferent_access.each_pair do |attr_name, attr_value|
           scim_attribute = self.class.complex_scim_attributes[attr_name].try(:first)
 
-          if scim_attribute && scim_attribute.complexType
+          if scim_attribute&.complexType
             if scim_attribute.multiValued
               self.send("#{attr_name}=", attr_value&.map {|attr_for_each_item| complex_type_from_hash(scim_attribute, attr_for_each_item)})
             else

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

@@ -473,7 +473,7 @@ module Scimitar
             path_str = operation['path' ]
             value    = operation['value']
 
-            unless ['add', 'remove', 'replace'].include?(nature)
+            unless %w[add remove replace].include?(nature)
               raise Scimitar::InvalidSyntaxError.new("Unrecognised PATCH \"op\" value of \"#{nature}\"")
             end
 
@@ -613,7 +613,7 @@ module Scimitar
                 built_dynamic_list = false
                 mapped_array = attrs_map_or_leaf_value.map do |value|
                   if ! value.is_a?(Hash)
-                    raise 'Bad attribute map: Array contains someting other than mapping Hash(es)'
+                    raise 'Bad attribute map: Array contains something other than mapping Hash(es)'
 
                   elsif value.key?(:match) # Static map
                     static_hash = { value[:match] => value[:with] }
@@ -741,7 +741,7 @@ module Scimitar
           # +path+::                    Array of SCIM attribute names giving a
           #                             path into the SCIM schema where
           #                             iteration has reached. Used to find the
-          #                             schema attribute definiton and check
+          #                             schema attribute definition and check
           #                             mutability before writing.
           #
           def from_scim_backend!(
@@ -1088,7 +1088,7 @@ module Scimitar
                     # associated collection or clearing a local model attribute
                     # directly to "nil").
                     #
-                    if handled == false
+                    unless handled
                       current_data_at_path[matched_index] = nil
                       compact_after = true
                     end
@@ -1290,7 +1290,7 @@ module Scimitar
                       end
                     end
 
-                    if handled == false
+                    unless handled
                       altering_hash[path_component] = []
                     end
 
@@ -1445,7 +1445,7 @@ module Scimitar
           #     { value: :work_email }
           #
           # If there was a SCIM entry with a type of something unrecognised,
-          # such as 'holday', then +nil+ would be returned since there is no
+          # such as 'holiday', then +nil+ would be returned since there is no
           # matching attribute map entry.
           #
           # Note that the <tt>:with_attr_map</tt> array can contain dynamic

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

@@ -36,7 +36,7 @@ module Scimitar
         scim_attributes.map { |scim_attribute| scim_attribute.clone }
       end
 
-      # Find a given attribute this schema, travelling down a path to any
+      # Find a given attribute of this schema, travelling down a path to any
       # sub-attributes within. Given that callers might be dealing with paths
       # into actual SCIM data, array indices for multi-value attributes are
       # allowed (as integers) and simply skipped - only the names are of

data/lib/scimitar/engine.rb

@@ -88,9 +88,9 @@ module Scimitar
       unrecognised_resources = resource_array - @standard_default_resources
 
       if unrecognised_resources.any?
-        raise "Scimitar::Engine::set_default_resources: Only #{@standard_default_resources.map(&:name).join(', ')} are supported"
+        raise "Scimitar::Engine.set_default_resources: Only #{@standard_default_resources.map(&:name).join(', ')} are supported"
       elsif resource_array.empty?
-        raise 'Scimitar::Engine::set_default_resources: At least one resource must be given'
+        raise 'Scimitar::Engine.set_default_resources: At least one resource must be given'
       end
 
       @default_resources = resource_array

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.9.0'
+  VERSION = '2.10.0'
 
   # Date for VERSION. If this changes, be sure to re-run "bundle install"
   # or "bundle update".
   #
-  DATE = '2024-06-27'
+  DATE = '2024-10-22'
 
 end

data/spec/controllers/scimitar/resource_types_controller_spec.rb

@@ -9,11 +9,15 @@ RSpec.describe Scimitar::ResourceTypesController do
     it 'renders the resource type for user' do
       get :index, format: :scim
       response_hash = JSON.parse(response.body)
-      expected_response = [ Scimitar::Resources::User.resource_type(scim_resource_type_url(name: 'User', test: 1)),
-                            Scimitar::Resources::Group.resource_type(scim_resource_type_url(name: 'Group', test: 1))
-      ].to_json
+      expected_response = {
+        schemas: ['urn:ietf:params:scim:api:messages:2.0:ListResponse'],
+        totalResults: 2,
+        Resources: [
+          Scimitar::Resources::User.resource_type(scim_resource_type_url(name: 'User', test: 1)),
+          Scimitar::Resources::Group.resource_type(scim_resource_type_url(name: 'Group', test: 1))
+        ]
+      }.to_json
 
-      response_hash = JSON.parse(response.body)
       expect(response_hash).to eql(JSON.parse(expected_response))
     end
 

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

@@ -555,7 +555,7 @@ RSpec.describe Scimitar::Resources::Mixin do
 
           expect do
             scim = instance.to_scim(location: 'https://test.com/static_map_test')
-          end.to raise_error(RuntimeError) { |e| expect(e.message).to include('Array contains someting other than mapping Hash(es)') }
+          end.to raise_error(RuntimeError) { |e| expect(e.message).to include('Array contains something other than mapping Hash(es)') }
         end
 
         it 'complains about bad Hash entries in mapping Arrays' do

data/spec/requests/engine_spec.rb

@@ -78,26 +78,26 @@ RSpec.describe Scimitar::Engine do
       end
 
       it 'notes changes to defaults' do
-        Scimitar::Engine::set_default_resources([Scimitar::Resources::User])
+        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.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')
+          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')
+          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"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scimitar
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - RIPA Global
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -101,14 +101,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: doggo
   requirement: !ruby/object:Gem::Requirement
@@ -267,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: SCIM v2 for Rails