Merge pull request #104 from CalebDW/file_attachments

Add embedded attachments to Events

Author: rubenvanassche

README.md

@@ -222,7 +222,7 @@ Event::create()
     ...
 ```
 
-You can add an attachment as such:
+You can add a url attachment as such:
 
 ```php
 Event::create()
@@ -231,6 +231,16 @@ Event::create()
     ...
 ```
 
+You can add an embedded attachment (base64) as such:
+
+```php
+Event::create()
+    ->embeddedAttachment($file->toString())
+    ->embeddedAttachment($fileString, 'application/json')
+    ->embeddedAttachment($base64String, 'application/json', needsEncoding: false)
+    ...
+```
+
 You can add an image as such:
 
 ``` php

src/Components/Event.php

@@ -12,6 +12,7 @@
 use Spatie\IcalendarGenerator\Enums\EventStatus;
 use Spatie\IcalendarGenerator\Enums\ParticipationStatus;
 use Spatie\IcalendarGenerator\Properties\AppleLocationCoordinatesProperty;
+use Spatie\IcalendarGenerator\Properties\BinaryProperty;
 use Spatie\IcalendarGenerator\Properties\CalendarAddressProperty;
 use Spatie\IcalendarGenerator\Properties\CoordinatesProperty;
 use Spatie\IcalendarGenerator\Properties\DateTimeProperty;
@@ -21,6 +22,7 @@
 use Spatie\IcalendarGenerator\Properties\UriProperty;
 use Spatie\IcalendarGenerator\Timezones\HasTimezones;
 use Spatie\IcalendarGenerator\Timezones\TimezoneRangeCollection;
+use Spatie\IcalendarGenerator\ValueObjects\BinaryValue;
 use Spatie\IcalendarGenerator\ValueObjects\CalendarAddress;
 use Spatie\IcalendarGenerator\ValueObjects\DateTimeValue;
 use Spatie\IcalendarGenerator\ValueObjects\RRule;
@@ -346,6 +348,16 @@ public function attachment(string $url, ?string $mediaType = null): Event
         return $this;
     }
 
+    public function embeddedAttachment(
+        string $data,
+        ?string $mediaType = null,
+        bool $needsEncoding = true,
+    ): Event {
+        $this->attachments[] = new BinaryValue($data, $mediaType, $needsEncoding);
+
+        return $this;
+    }
+
     public function image(string $url, ?string $mime = null, ?Display $display = null): Event
     {
         $this->images[] = [
@@ -449,9 +461,15 @@ private function resolveProperties(ComponentPayload $payload): self
             )
             ->multiple(
                 $this->attachments,
-                fn (array $attachment) => $attachment['type'] !== null
-                    ? UriProperty::create('ATTACH', $attachment['url'])->addParameter(Parameter::create('FMTTYPE', $attachment['type']))
-                    : UriProperty::create('ATTACH', $attachment['url'])
+                function (array|BinaryValue $attachment) {
+                    if ($attachment instanceof BinaryValue) {
+                        return BinaryProperty::create('ATTACH', $attachment);
+                    }
+
+                    return $attachment['type'] !== null
+                        ? UriProperty::create('ATTACH', $attachment['url'])->addParameter(Parameter::create('FMTTYPE', $attachment['type']))
+                        : UriProperty::create('ATTACH', $attachment['url']);
+                }
             )
             ->multiple(
                 $this->images,

src/Properties/BinaryProperty.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Spatie\IcalendarGenerator\Properties;
+
+use Spatie\IcalendarGenerator\ValueObjects\BinaryValue;
+
+final class BinaryProperty extends Property
+{
+    private BinaryValue $binaryValue;
+
+    public static function create(string $name, BinaryValue $binaryValue): BinaryProperty
+    {
+        return new self($name, $binaryValue);
+    }
+
+    public function __construct(string $name, BinaryValue $binaryValue)
+    {
+        $this->name = $name;
+        $this->binaryValue = $binaryValue;
+
+        if ($this->binaryValue->fmttype) {
+            $this->addParameter(Parameter::create('FMTTYPE', $this->binaryValue->fmttype));
+        }
+
+        $this->addParameter(Parameter::create('ENCODING', 'BASE64'));
+        $this->addParameter(Parameter::create('VALUE', 'BINARY'));
+    }
+
+    public function getValue(): string
+    {
+        return $this->binaryValue->data;
+    }
+
+    public function getOriginalValue(): BinaryValue
+    {
+        return $this->binaryValue;
+    }
+}

src/ValueObjects/BinaryValue.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Spatie\IcalendarGenerator\ValueObjects;
+
+class BinaryValue
+{
+    public string $data;
+
+    public ?string $fmttype;
+
+    public function __construct(
+        string $data,
+        ?string $fmttype = null,
+        bool $needsEncoding = true,
+    ) {
+        $this->data = $needsEncoding
+            ? base64_encode($data)
+            : $data;
+
+        $this->fmttype = $fmttype;
+    }
+}

tests/Components/EventTest.php

@@ -457,6 +457,32 @@ function (PropertyExpectation $expectation) use ($dateD, $dateA) {
     );
 });
 
+test('it can add an embedded attachment to an event', function () {
+    $file = file_get_contents('.gitignore');
+    $base64File = base64_encode(file_get_contents('.gitattributes'));
+
+    $payload = Event::create()
+        ->embeddedAttachment($file, 'text/plain')
+        ->embeddedAttachment($base64File, 'text/plain', false)
+        ->resolvePayload();
+
+    PayloadExpectation::create($payload)->expectProperty(
+        'ATTACH',
+        fn (PropertyExpectation $expectation) => $expectation
+            ->expectParameterCount(3)
+            ->expectParameterValue('FMTTYPE', 'text/plain')
+            ->expectParameterValue('ENCODING', 'BASE64')
+            ->expectParameterValue('VALUE', 'BINARY')
+            ->expectOutput(base64_encode($file)),
+        fn (PropertyExpectation $expectation) => $expectation
+            ->expectParameterCount(3)
+            ->expectParameterValue('FMTTYPE', 'text/plain')
+            ->expectParameterValue('ENCODING', 'BASE64')
+            ->expectParameterValue('VALUE', 'BINARY')
+            ->expectOutput($base64File),
+    );
+});
+
 test('it can add an image to an event', function () {
     $payload = Event::create()
         ->image('http://spatie.be/logo.svg')

tests/Properties/BinaryPropertyTest.php

@@ -0,0 +1,55 @@
+<?php
+
+use Spatie\IcalendarGenerator\Properties\BinaryProperty;
+use Spatie\IcalendarGenerator\Tests\PropertyExpectation;
+use Spatie\IcalendarGenerator\ValueObjects\BinaryValue;
+
+test('it can create a binary property type', function () {
+    $fileString = file_get_contents('.gitignore');
+
+    $property = new BinaryProperty(
+        'ATTACH',
+        new BinaryValue($fileString)
+    );
+
+    PropertyExpectation::create($property)
+        ->expectName('ATTACH')
+        ->expectOutput(base64_encode($fileString))
+        ->expectParameterCount(2)
+        ->expectParameterValue('ENCODING', 'BASE64')
+        ->expectParameterValue('VALUE', 'BINARY');
+});
+
+test('it can set a media type', function () {
+    $fileString = file_get_contents('.gitignore');
+
+    $property = new BinaryProperty(
+        'ATTACH',
+        new BinaryValue($fileString, 'text/plain')
+    );
+
+    PropertyExpectation::create($property)
+        ->expectName('ATTACH')
+        ->expectOutput(base64_encode($fileString))
+        ->expectParameterCount(3)
+        ->expectParameterValue('FMTTYPE', 'text/plain')
+        ->expectParameterValue('ENCODING', 'BASE64')
+        ->expectParameterValue('VALUE', 'BINARY');
+});
+
+test('it can accept base64 encoded content', function () {
+    $fileString = base64_encode(file_get_contents('.gitignore'));
+
+    $property = new BinaryProperty(
+        'ATTACH',
+        new BinaryValue($fileString, 'text/plain', false)
+    );
+
+    PropertyExpectation::create($property)
+        ->expectName('ATTACH')
+        ->expectOutput($fileString)
+        ->expectParameterCount(3)
+        ->expectParameterValue('FMTTYPE', 'text/plain')
+        ->expectParameterValue('ENCODING', 'BASE64')
+        ->expectParameterValue('VALUE', 'BINARY');
+});