Support remove operations by specifying path with a filter (limosa-io#113)

Author: arietimmerman

src/Attribute/MutableCollection.php

@@ -31,11 +31,39 @@ public function add($value, Model &$object)
         $object->load($this->attribute);
     }
 
-    public function remove($value, Model &$object, Path $path = null)
+    public function remove($value, Model &$object, ?Path $path = null)
     {
-        $values = collect($value)->pluck('value')->all();
+        if ($path?->getValuePathFilter()?->getComparisonExpression() != null) {
+            $attributes = $path?->getValuePathFilter()?->getComparisonExpression()?->attributePath?->attributeNames;
+            $operator = $path?->getValuePathFilter()?->getComparisonExpression()?->operator;
+            $compareValue = $path?->getValuePathFilter()?->getComparisonExpression()?->compareValue;
+            
+            if ($value != null) {
+                throw new SCIMException('Remove operation with filter requires a null value parameter', 400);
+            }
+
+            if (count($attributes) != 1) {
+                throw new SCIMException(sprintf('Filter must specify exactly one attribute, found %d attributes', count($attributes)), 400);
+            }
+
+            if ($operator != 'eq') {
+                throw new SCIMException(sprintf('Unsupported filter operator "%s" - only "eq" is supported', $operator), 400);
+            }
+
+            if ($attributes[0] != 'value') {
+                throw new SCIMException(sprintf('Cannot filter on "%s" - only filtering on "value" attribute is supported', $attributes[0]), 400);
+            }
+
+            if ($value != null) {
+                throw new SCIMException('Cannot specify both a filter path and a value parameter simultaneously', 400);
+            }
+
+            $object->{$this->attribute}()->detach([$compareValue]);
+        } else {
+            $values = collect($value)->pluck('value')->all();
 
-        $object->{$this->attribute}()->detach($values);
+            $object->{$this->attribute}()->detach($values);
+        }
 
         $object->load($this->attribute);
     }

tests/BasicTest.php

@@ -4,6 +4,7 @@
 
 use ArieTimmerman\Laravel\SCIMServer\ResourceType;
 use ArieTimmerman\Laravel\SCIMServer\SCIMConfig;
+use ArieTimmerman\Laravel\SCIMServer\Tests\Model\Group;
 use Illuminate\Support\Arr;
 
 class BasicTest extends TestCase
@@ -239,6 +240,23 @@ public function testFilterByGroup()
         ]);
 
         $response->assertStatus(200);
+
+        $this->assertTrue(Group::find($groupValue)->members->pluck('id')->contains($userValue), 'User was not added to the group');        
+
+        // SCIM Patch remove member request
+        $response = $this->patch('/scim/v2/Groups/' . $groupValue, [
+            "schemas" => [
+                "urn:ietf:params:scim:api:messages:2.0:PatchOp",
+            ],
+            "Operations" => [[
+                "op" => "remove",
+                "path" => sprintf("members[value eq \"%s\"]", $userValue),
+            ]]
+        ]);
+
+        $response->assertStatus(200);
+
+        $this->assertFalse(Group::find($groupValue)->members->pluck('id')->contains($userValue), 'User was not removed from the group');
     }
 
     public function testSearch()