Allow not returning certain attributes (limosa-io#94)

Author: arietimmerman

src/Attribute/Attribute.php

@@ -39,6 +39,7 @@ class Attribute
     protected $type = 'string';
     protected $description = null;
     protected $defaultValue = null;
+    protected $returned = 'default';
 
     public $dirty = false;
 
@@ -68,7 +69,7 @@ public function generateSchema(){
             'name' => $this->name,
             'type' => $this->type,
             'mutability' => $this->mutability,
-            'returned' => 'default',
+            'returned' => $this->returned,
             'uniqueness' => 'server',
             'required' => $this->isRequired(),
             'multiValued' => $this->getMultiValued(),
@@ -133,6 +134,11 @@ public function shouldReturn(&$object)
         return true;
     }
 
+    public function setReturned($returned){
+        $this->returned = $returned;
+        return $this;
+    }
+
     public function setParent($parent)
     {
         $this->parent = $parent;
@@ -150,6 +156,10 @@ public function read(&$object, array $attributes = []): ?AttributeValue
             return null;
         }
 
+        if($this->returned == 'never'){
+            return null;
+        }
+
         return new AttributeValue($this->doRead($object, $attributes) ?? $this->defaultValue);
     }
 

src/SCIMConfig.php

@@ -78,7 +78,7 @@ protected function doRead(&$object, $attributes = [])
                     eloquent('userName', 'name')->ensure('required'),
                     eloquent('active')->ensure('boolean')->default(false),
                     complex('name')->withSubAttributes(eloquent('formatted')),
-                    eloquent('password')->ensure('nullable'),
+                    eloquent('password')->ensure('nullable')->setReturned('never'),
                     (new class ('emails') extends Complex {
                         protected function doRead(&$object, $attributes = [])
                         {

tests/BasicTest.php

@@ -369,6 +369,7 @@ public function testPost()
         $this->assertArrayHasKey('urn:ietf:params:scim:schemas:core:2.0:User', $json);
         $this->assertEquals('mariejo@example.com', $json['urn:ietf:params:scim:schemas:core:2.0:User']['emails'][0]['value']);
         $this->assertEquals('Dr. Marie Jo', $json['urn:ietf:params:scim:schemas:core:2.0:User']['userName']);
+        $this->assertArrayNotHasKey('password', $json['urn:ietf:params:scim:schemas:core:2.0:User']);
     }
 
     public function testPostTopLevel()