scimaenaga 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3959060e28dd1554d42df95f07f0bf311ce1f59da0f0d9bce9a3467193874d9b
-  data.tar.gz: c6ffc092a2584e829db8011b76d7c0e8f73c3ebe2422d993682409db90e59439
+  metadata.gz: 6d2d55daa03a9b1e4771b1f2e1287a75075514d57faeb0075ea8784a7dd8cc9e
+  data.tar.gz: b4a38c2c629cce871703a2a1874c3be93e34d55f0d5eacadae8da9b8c5e5c438
 SHA512:
-  metadata.gz: 013aba54f061b96a3ebe964f285a0d26bfd41062270ca50572c7633bb1a0a7e40c6668d7a5709da9b80c4883e14b07f75f14bb2e1a18dc44d5c90bcb80abe868
-  data.tar.gz: f31c1577377e803693ba5932ff1c64f794e2de44b5d55fd2ad1e89219a9d020e499002ef8e83a97ce81316e3d267abd44b1bd57639f69060234eeecf301bb730
+  metadata.gz: 43e2ec416e2f9bad5c185042aff3e6fd576437d3d9bff5ac6ad5d1f930246fa0b59b12e1940a5498e386c8c8f385a245d531907e7ab5850cc8ebc5a7c35df607
+  data.tar.gz: 284bead26bc660ca0d4cc229dd5f13102501904b7658e3e780f5ea5657eb367c52cd5399d4a29dcd20af66eee19ce4592af7defa62c2f182bb7b23f76ebe6a31

data/app/controllers/concerns/scim_rails/exception_handler.rb

@@ -7,6 +7,9 @@ module ScimRails
     class InvalidCredentials < StandardError
     end
 
+    class InvalidRequest < StandardError
+    end
+
     class InvalidQuery < StandardError
     end
 
@@ -16,6 +19,12 @@ module ScimRails
     class UnsupportedDeleteRequest < StandardError
     end
 
+    class InvalidConfiguration < StandardError
+    end
+
+    class UnexpectedError < StandardError
+    end
+
     included do
       if Rails.env.production?
         rescue_from StandardError do |exception|
@@ -47,6 +56,17 @@ module ScimRails
         )
       end
 
+      rescue_from ScimRails::ExceptionHandler::InvalidRequest do |e|
+        json_response(
+          {
+            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
+            detail: "Invalid request. #{e.message}",
+            status: "400"
+          },
+          :bad_request
+        )
+      end
+
       rescue_from ScimRails::ExceptionHandler::InvalidQuery do
         json_response(
           {
@@ -63,7 +83,7 @@ module ScimRails
         json_response(
           {
             schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
-            detail: "Invalid PATCH request. This PATCH endpoint only supports deprovisioning and reprovisioning records.",
+            detail: "Invalid PATCH request.",
             status: "422"
           },
           :unprocessable_entity
@@ -81,6 +101,28 @@ module ScimRails
         )
       end
 
+      rescue_from ScimRails::ExceptionHandler::InvalidConfiguration do |e|
+        json_response(
+          {
+            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
+            detail: "Invalid configuration. #{e.message}",
+            status: "500"
+          },
+          :internal_server_error
+        )
+      end
+
+      rescue_from ScimRails::ExceptionHandler::UnexpectedError do |e|
+        json_response(
+          {
+            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
+            detail: "Unexpected Error. #{e.message}",
+            status: "500"
+          },
+          :internal_server_error
+        )
+      end
+
       rescue_from ActiveRecord::RecordNotFound do |e|
         json_response(
           {

data/app/controllers/scim_rails/scim_groups_controller.rb

@@ -68,13 +68,24 @@ module ScimRails
 
     def destroy
       unless ScimRails.config.group_destroy_method
-        raise ScimRails::ExceptionHandler::UnsupportedDeleteRequest
+        raise ScimRails::ExceptionHandler::InvalidConfiguration
       end
 
       group = @company
               .public_send(ScimRails.config.scim_groups_scope)
               .find(params[:id])
-      group.public_send(ScimRails.config.group_destroy_method)
+      raise ActiveRecord::RecordNotFound unless group
+
+      begin
+        group.public_send(ScimRails.config.group_destroy_method)
+      rescue NoMethodError => e
+        raise ScimRails::ExceptionHandler::InvalidConfiguration, e.message
+      rescue ActiveRecord::RecordNotDestroyed => e
+        raise ScimRails::ExceptionHandler::InvalidRequest, e.message
+      rescue => e
+        raise ScimRails::ExceptionHandler::UnexpectedError, e.message
+      end
+
       head :no_content
     end
 

data/app/controllers/scim_rails/scim_users_controller.rb

@@ -71,6 +71,27 @@ module ScimRails
       json_scim_response(object: user)
     end
 
+    def destroy
+      unless ScimRails.config.user_destroy_method
+        raise ScimRails::ExceptionHandler::InvalidConfiguration
+      end
+
+      user = @company.public_send(ScimRails.config.scim_users_scope).find(params[:id])
+      raise ActiveRecord::RecordNotFound unless user
+
+      begin
+        user.public_send(ScimRails.config.user_destroy_method)
+      rescue NoMethodError => e
+        raise ScimRails::ExceptionHandler::InvalidConfiguration, e.message
+      rescue ActiveRecord::RecordNotDestroyed => e
+        raise ScimRails::ExceptionHandler::InvalidRequest, e.message
+      rescue => e
+        raise ScimRails::ExceptionHandler::UnexpectedError, e.message
+      end
+
+      head :no_content
+    end
+
     private
 
       def permitted_user_params

data/app/libraries/scim_patch.rb

@@ -5,9 +5,8 @@ class ScimPatch
   attr_accessor :operations
 
   def initialize(params, mutable_attributes_schema)
-    # FIXME: raise proper error.
     unless params['schemas'] == ['urn:ietf:params:scim:api:messages:2.0:PatchOp']
-      raise StandardError
+      raise ScimRails::ExceptionHandler::UnsupportedPatchRequest
     end
     if params['Operations'].nil?
       raise ScimRails::ExceptionHandler::UnsupportedPatchRequest

data/app/libraries/scim_patch_operation.rb

@@ -2,57 +2,126 @@
 
 # Parse One of "Operations" in PATCH request
 class ScimPatchOperation
-  attr_accessor :op, :path_scim, :path_sp, :value
+
+  # 1 Operation means 1 attribute change
+  # If 1 value is specified, @operations has 1 "Operation" struct.
+  # If 3 value is specified, @operations has 3 "Operation" struct.
+  attr_accessor :operations
+
+  Operation = Struct.new('Operation', :op, :path_scim, :path_sp, :value)
 
   def initialize(op, path, value, mutable_attributes_schema)
-    # FIXME: Raise proper Error
-    raise StandardError unless op.downcase.in? %w[add replace remove]
-
-    # No path is not supported.
-    # FIXME: Raise proper Error
-    raise ScimRails::ExceptionHandler::UnsupportedPatchRequest if path.nil?
-    raise ScimRails::ExceptionHandler::UnsupportedPatchRequest if value.nil?
-
-    @op = op.downcase.to_sym
-    @path_scim = path
-    @path_sp = convert_path(path, mutable_attributes_schema)
-    @value = convert_bool_if_string(value, @path_scim)
+    op_downcase = op.downcase
+
+    unless op_downcase.in? %w[add replace remove]
+      raise ScimRails::ExceptionHandler::UnsupportedPatchRequest
+    end
+
+    @operations = []
+
+    # To handle request pattern A and B in the same way,
+    # convert complex-value to path + single-value
+    #
+    # pattern A
+    # {
+    #   "op": "replace",
+    #   "value": {
+    #       "displayName": "Suzuki Taro",
+    #       "name.givenName": "taro"
+    #   }
+    # }
+    # => [{path: displayName, value: "Suzuki Taro"}, {path: name.givenName, value: "taro"}]
+    #
+    # pattern B
+    # [
+    #   {
+    #     "op": "replace",
+    #     "path": "displayName"
+    #     "value": "Suzuki Taro",
+    #   },
+    #   {
+    #     "op": "replace",
+    #     "path": "name.givenNAme"
+    #     "value": "taro",
+    #   },
+    # ]
+    if value.instance_of?(Hash) || value.instance_of?(ActionController::Parameters)
+      create_multiple_operations(op_downcase, path, value, mutable_attributes_schema)
+    else
+      create_operation(op_downcase, path, value, mutable_attributes_schema)
+    end
   end
 
   def save(model)
-    if @path_scim == 'members' # Only members are supported for value is an array
-      update_member_ids = @value.map do |v|
-        v[ScimRails.config.group_member_relation_schema.keys.first].to_s
+    @operations.each do |operation|
+      apply_operation(model, operation)
+    end
+  end
+
+  private
+
+    def apply_operation(model, operation)
+      if operation.path_scim == 'members' # Only members are supported for value is an array
+        update_member_ids = operation.value.map do |v|
+          v[ScimRails.config.group_member_relation_schema.keys.first].to_s
+        end
+
+        current_member_ids = model.public_send(
+          ScimRails.config.group_member_relation_attribute
+        ).map(&:to_s)
+        case operation.op
+        when :add
+          member_ids = current_member_ids.concat(update_member_ids)
+        when :replace
+          member_ids = current_member_ids.concat(update_member_ids)
+        when :remove
+          member_ids = current_member_ids - update_member_ids
+        end
+
+        # Only the member addition process is saved by each ids
+        model.public_send("#{ScimRails.config.group_member_relation_attribute}=",
+                          member_ids.uniq)
+        return
       end
 
-      current_member_ids = model
-                           .public_send(ScimRails.config.group_member_relation_attribute).map(&:to_s)
-      case @op
-      when :add
-        member_ids = current_member_ids.concat(update_member_ids)
-      when :replace
-        member_ids = current_member_ids.concat(update_member_ids)
+      case operation.op
+      when :add, :replace
+        model.attributes = { operation.path_sp => operation.value }
       when :remove
-        member_ids = current_member_ids - update_member_ids
+        model.attributes = { operation.path_sp => nil }
       end
-
-      # Only the member addition process is saved by each ids
-      model.public_send("#{ScimRails.config.group_member_relation_attribute}=",
-                        member_ids.uniq)
-      return
     end
 
-    case @op
-    when :add, :replace
-      model.attributes = { @path_sp => @value }
-    when :remove
-      model.attributes = { @path_sp => nil }
+    def create_operation(op, path_scim, value, mutable_attributes_schema)
+      path_sp = convert_path(path_scim, mutable_attributes_schema)
+      value = convert_bool_if_string(value, path_scim)
+      @operations << Operation.new(op.to_sym, path_scim, path_sp, value)
     end
-  end
 
-  private
+    # convert hash value to 1 path + 1 value
+    # each path is created by path_scim_base + key of value
+    def create_multiple_operations(op, path_scim_base, hash_value, mutable_attributes_schema)
+      hash_value.each do |k, v|
+        # Typical request is path_scim_base = nil and value = complex-value:
+        # {
+        #   "op": "replace",
+        #   "value": {
+        #       "displayName": "Taro Suzuki",
+        #       "name.givenName": "taro"
+        #   }
+        # }
+        path_scim = if path_scim_base.present?
+                      "#{path_scim_base}.#{k}"
+                    else
+                      k
+                    end
+        create_operation(op, path_scim, v, mutable_attributes_schema)
+      end
+    end
 
     def convert_path(path, mutable_attributes_schema)
+      return nil if path.nil?
+
       # For now, library does not support Multi-Valued Attributes properly.
       # examle:
       #   path = 'emails[type eq "work"].value'

data/config/routes.rb

@@ -4,6 +4,7 @@ ScimRails::Engine.routes.draw do
   get    'scim/v2/Users/:id',  action: :show,          controller: 'scim_users'
   put    'scim/v2/Users/:id',  action: :put_update,    controller: 'scim_users'
   patch  'scim/v2/Users/:id',  action: :patch_update,  controller: 'scim_users'
+  delete 'scim/v2/Users/:id',  action: :destroy,       controller: 'scim_users'
   get    'scim/v2/Groups',     action: :index,         controller: 'scim_groups'
   post   'scim/v2/Groups',     action: :create,        controller: 'scim_groups'
   get    'scim/v2/Groups/:id', action: :show,          controller: 'scim_groups'

data/lib/scim_rails/config.rb

@@ -44,6 +44,7 @@ module ScimRails
       :user_attributes,
       :user_schema,
       :group_schema,
+      :user_destroy_method,
       :group_destroy_method
 
     def initialize

data/lib/scim_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ScimRails
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

data/spec/controllers/scim_rails/scim_groups_controller_spec.rb

@@ -505,12 +505,6 @@ RSpec.describe ScimRails::ScimGroupsController, type: :controller do
       end
 
       context 'when Group destroy method is configured' do
-        before do
-          allow(ScimRails.config).to(
-            receive(:group_destroy_method).and_return(:destroy!)
-          )
-        end
-
         it 'returns empty response' do
           delete :destroy, params: { id: 1 }, as: :json
 
@@ -557,7 +551,31 @@ RSpec.describe ScimRails::ScimGroupsController, type: :controller do
             delete :destroy, params: { id: 1 }, as: :json
           end.not_to change { company.groups.reload.count }.from(1)
 
-          expect(response.status).to eq 501
+          expect(response.status).to eq 500
+        end
+      end
+
+      context 'when Group destroy method is invalid' do
+        it 'does not delete Group' do
+          allow(ScimRails.config).to(
+            receive(:group_destroy_method).and_return('destory!')
+          )
+
+          expect do
+            delete :destroy, params: { id: 1 }, as: :json
+          end.not_to change { company.groups.reload.count }.from(1)
+
+          expect(response.status).to eq 500
+        end
+      end
+
+      context 'whenr target Group is not found' do
+        it 'return 404 not found' do
+          expect do
+            delete :destroy, params: { id: 999999 }, as: :json
+          end.not_to change { company.groups.reload.count }.from(1)
+
+          expect(response.status).to eq 404
         end
       end
     end