wip

Author: Sebastian Fix

.github/workflows/run-tests.yml

@@ -52,8 +52,6 @@ jobs:
           M_FILES_PASSWORD: ${{ secrets.M_FILES_PASSWORD }}
           M_FILES_VAULT_GUID: ${{ secrets.M_FILES_VAULT_GUID }}
           M_FILES_CACHE_DRIVER: ${{ secrets.M_FILES_CACHE_DRIVER }}
-          M_FILES_CACHE_LIFETIME_IN_SECONDS: ${{ secrets.M_FILES_CACHE_LIFETIME_IN_SECONDS }}
-          SALOON_FIXTURE_REDACTION: true
 
       - name: Store Log Artifacts
         if: failure()

README.md

@@ -40,14 +40,13 @@ M_FILES_CACHE_DRIVER=file
 
 #### Authentication
 - `GetAuthenticationToken` - Get authentication token using username/password
-- `LogoutSession` - Logout a session with session ID
+- `LogOutFromVaultRequest` - Logout from vault with session ID
 
-#### User Operations
-- `GetCurrentUserRequest` - Get information about the current authenticated user
+#### Vault Operations
+- `GetVaultsRequest` - Get list of available vaults for the authenticated user
 
-#### Document Operations
-- `GetDocumentsRequest` - Get documents with optional filtering
-- `GetDocumentPropertiesRequest` - Get document properties
+#### Object Operations
+- `GetObjectPropertiesRequest` - Get object properties (works for documents, folders, and other object types)
 
 #### File Operations
 - `UploadFileRequest` - Upload a file to M-Files
@@ -62,6 +61,7 @@ M_FILES_CACHE_DRIVER=file
 - `PropertyValue` - Represents a property value for creating documents
 - `Document` - Represents a document in M-Files
 - `Documents` - Represents a collection of documents
+- `ObjectProperties` - Represents object properties in M-Files
 - `File` - Represents a file in M-Files
 - `DownloadedFile` - Represents a downloaded file with content and metadata
 - `User` - Represents a user in M-Files
@@ -112,62 +112,60 @@ $token = $request->send()->dto();
 // Returns AuthenticationToken with sessionId
 ```
 
-**Logout Session**
+**Logout from Vault**
 ```php
-use CodebarAg\MFiles\Requests\Authentication\LogoutSession;
+use CodebarAg\MFiles\Requests\Authentication\LogOutFromVaultRequest;
 
-$logout = (new LogoutSession(config: $config))->send()->dto();
+$logout = (new LogOutFromVaultRequest(config: $config))->send()->dto();
 // Returns true on successful logout, clears cached token
 ```
 
-#### User Operations
+#### Vault Operations
 
-**Get Current User**
+**Get Available Vaults**
 ```php
-use CodebarAg\MFiles\Requests\GetCurrentUserRequest;
-use CodebarAg\MFiles\DTO\User;
+use CodebarAg\MFiles\Requests\GetVaultsRequest;
 
-$user = $connector->send(new GetCurrentUserRequest())->dto();
-// Returns User DTO with id, name, email, etc.
+$vaults = $connector->send(new GetVaultsRequest())->json();
+// Returns array of available vaults for the authenticated user
 ```
 
-#### Document Operations
+#### Object Operations
 
-**Get Documents**
+**Get Object Properties**
 ```php
-use CodebarAg\MFiles\Requests\GetDocumentsRequest;
-use CodebarAg\MFiles\DTO\Documents;
+use CodebarAg\MFiles\Requests\GetObjectPropertiesRequest;
+use CodebarAg\MFiles\DTO\ObjectProperties;
 
-$documents = $connector->send(new GetDocumentsRequest())->dto();
-// Returns Documents collection with pagination info
+$properties = $connector->send(new GetObjectPropertiesRequest(
+    objectType: 0, // 0 for documents, 1 for folders, etc.
+    objectId: 123
+))->dto();
+// Returns ObjectProperties with property details
 
-// With filtering parameters
-$documents = $connector->send(new GetDocumentsRequest(
-    page: 1,
-    pageSize: 5,
-    searchString: 'Sample',
-    objectTypeId: 0,
-    includeDeleted: false,
-    includeSubfolders: true,
-    sortBy: 'Title',
-    sortDirection: 'asc'
+// With optional parameters
+$properties = $connector->send(new GetObjectPropertiesRequest(
+    objectType: 0,
+    objectId: 123,
+    includeDeleted: false
 ))->dto();
 ```
 
-**Get Document Properties**
+**Get Object Properties**
 ```php
-use CodebarAg\MFiles\Requests\GetDocumentPropertiesRequest;
-use CodebarAg\MFiles\DTO\DocumentProperties;
+use CodebarAg\MFiles\Requests\GetObjectPropertiesRequest;
+use CodebarAg\MFiles\DTO\ObjectProperties;
 
-$properties = $connector->send(new GetDocumentPropertiesRequest(
+$properties = $connector->send(new GetObjectPropertiesRequest(
+    objectType: 0, // 0 for documents, 1 for folders, etc.
     objectId: 123
 ))->dto();
-// Returns DocumentProperties with property details
+// Returns ObjectProperties with property details
 
 // With optional parameters
-$properties = $connector->send(new GetDocumentPropertiesRequest(
+$properties = $connector->send(new GetObjectPropertiesRequest(
+    objectType: 0,
     objectId: 123,
-    objectTypeId: 0,
     includeDeleted: false
 ))->dto();
 ```
@@ -246,8 +244,8 @@ $downloadedFile = $connector->send(new DownloadFileRequest(
 ```php
 use CodebarAg\MFiles\Connectors\MFilesConnector;
 use CodebarAg\MFiles\DTO\Config\ConfigWithCredentials;
-use CodebarAg\MFiles\Requests\GetCurrentUserRequest;
-use CodebarAg\MFiles\Requests\GetDocumentsRequest;
+use CodebarAg\MFiles\Requests\GetVaultsRequest;
+use CodebarAg\MFiles\Requests\GetObjectPropertiesRequest;
 use CodebarAg\MFiles\Requests\CreateSingleFileDocumentRequest;
 use CodebarAg\MFiles\Requests\UploadFileRequest;
 use CodebarAg\MFiles\Requests\DownloadFileRequest;
@@ -266,11 +264,11 @@ $config = new ConfigWithCredentials(
 
 $connector = new MFilesConnector(config: $config);
 
-// Get current user
-$user = $connector->send(new GetCurrentUserRequest())->dto();
+// Get available vaults
+$vaults = $connector->send(new GetVaultsRequest())->json();
 
-// Get documents
-$documents = $connector->send(new GetDocumentsRequest())->dto();
+// Get document properties (example with document ID 123)
+$properties = $connector->send(new GetObjectPropertiesRequest(objectType: 0, objectId: 123))->dto();
 
 // Upload a file
 $fileContent = file_get_contents('document.pdf');
@@ -290,10 +288,9 @@ $document = $connector->send(new CreateSingleFileDocumentRequest(
 ))->dto();
 
 // Download a file from a document
-$file = $document->files->first();
 $downloadedFile = $connector->send(new DownloadFileRequest(
     objectId: $document->id,
-    fileId: $file->id
+    fileId: 101
 ))->dto();
 
 

composer.json

@@ -27,7 +27,8 @@
         "saloonphp/cache-plugin": "^3.0",
         "saloonphp/laravel-plugin": "^3.0",
         "saloonphp/saloon": "^3.10.1",
-        "spatie/laravel-package-tools": "^1.19"
+        "spatie/laravel-package-tools": "^1.19",
+        "spatie/laravel-ray": "^1.40"
     },
     "require-dev": {
         "laravel/pint": "^1.21",

config/m-files.php

@@ -5,7 +5,7 @@
         'url' => env('M_FILES_URL'),
         'username' => env('M_FILES_USERNAME'),
         'password' => env('M_FILES_PASSWORD'),
-        'expiration' => env('M_FILES_EXPIRATION_SECONDS', '3600'), // Default to 1 hour
+        'expiration' => env('M_FILES_EXPIRATION_SECONDS', 1),
         'session_id' => env('M_FILES_SESSION_ID'),
     ],
 

phpunit.xml.dist

@@ -26,8 +26,6 @@
     <env name="M_FILES_PASSWORD" value=""/>
     <env name="M_FILES_VAULT_GUID" value=""/>
     <env name="M_FILES_CACHE_DRIVER" value="file"/>
-    <env name="M_FILES_CACHE_LIFETIME_IN_SECONDS" value="0"/>
-    <env name="SALOON_FIXTURE_REDACTION" value="true"/>
 </php>
 <source>
     <include>

src/Connectors/MFilesConnector.php

@@ -4,7 +4,9 @@
 
 namespace CodebarAg\MFiles\Connectors;
 
+use CodebarAg\MFiles\DTO\Authentication\AuthenticationToken;
 use CodebarAg\MFiles\DTO\Config\ConfigWithCredentials;
+use Saloon\Http\Auth\HeaderAuthenticator;
 use Saloon\Http\Connector;
 use Saloon\Traits\Plugins\AcceptsJson;
 
@@ -26,7 +28,13 @@ public function defaultHeaders(): array
         return [
             'Accept' => 'application/json',
             'Content-Type' => 'application/json',
-            'X-Authentication' => $this->configuration->authenticationToken->value,
         ];
     }
+
+    protected function defaultAuth(): HeaderAuthenticator
+    {
+        $token = AuthenticationToken::getOrCreate($this->configuration);
+
+        return new HeaderAuthenticator($token->value, 'X-Authentication');
+    }
 }

src/DTO/Authentication/AuthenticationToken.php

@@ -4,35 +4,22 @@
 
 namespace CodebarAg\MFiles\DTO\Authentication;
 
-use Carbon\CarbonImmutable;
-use CodebarAg\MFiles\Requests\Authentication\GetAuthenticationToken;
-use Illuminate\Support\Arr;
-use Illuminate\Support\Facades\Cache;
+use CodebarAg\MFiles\DTO\Config\ConfigWithCredentials;
+use CodebarAg\MFiles\Helpers\CacheKeyManager;
+use CodebarAg\MFiles\Requests\LogInToVaultRequest;
+use Illuminate\Support\Str;
 
 class AuthenticationToken
 {
     public function __construct(
         public string $value,
-        public ?CarbonImmutable $expiration = null,
-        public ?string $sessionId = null
+        public ?string $sessionId = null,
     ) {}
 
-    public static function fromArray(array $data): self
-    {
-        $expiration = Arr::get($data, 'Expiration');
-
-        return new self(
-            value: Arr::get($data, 'Value', ''),
-            expiration: $expiration ? CarbonImmutable::parse($expiration) : null,
-            sessionId: Arr::get($data, 'SessionID')
-        );
-    }
-
     public function toArray(): array
     {
         return [
             'Value' => $this->value,
-            'Expiration' => $this->expiration?->toISOString(),
             'SessionID' => $this->sessionId,
         ];
     }
@@ -41,77 +28,19 @@ public function toArray(): array
      * Get or create an authentication token with caching
      */
     public static function getOrCreate(
-        string $url,
-        string $username,
-        string $password,
-        ?string $vaultGuid = null,
-        ?string $cacheDriver = null,
+        ConfigWithCredentials $config
     ): AuthenticationToken {
-        $cacheKey = self::generateCacheKey($url, $username, $password, $vaultGuid);
-        $cacheDriver = $cacheDriver ?? config('m-files.cache_driver');
-
-        $cachedToken = Cache::store($cacheDriver)->get($cacheKey);
-
-        if ($cachedToken && $cachedToken->isValid()) {
-            return $cachedToken;
-        }
-
-        // Create new token
-        $expirationInSeconds = (int) config('m-files.auth.expiration', 3600);
-        $expiration = CarbonImmutable::now()->addSeconds($expirationInSeconds)->toISOString();
-
-        $token = new GetAuthenticationToken(
-            url: $url,
-            username: $username,
-            password: $password,
-            vaultGuid: $vaultGuid,
-            expiration: $expiration
-        )->send()->dto();
-
-        // Store in cache
-        self::storeInCache($cacheKey, $token, $cacheDriver);
-
-        return $token;
-    }
-
-    /**
-     * Check if the token is still valid
-     */
-    public function isValid(): bool
-    {
-        // If no expiration is set, consider the token valid
-        // (it will be managed by the cache TTL instead)
-        if (! $this->expiration) {
-            return true;
-        }
-
-        $currentTime = CarbonImmutable::now();
-
-        // Consider token valid if it expires in more than 5 minutes
-        return $this->expiration->gt($currentTime->addMinutes(5));
-    }
-
-    /**
-     * Generate a unique cache key based on URL, username, password, and vault GUID
-     */
-    public static function generateCacheKey(string $url, string $username, string $password, ?string $vaultGuid = null): string
-    {
-        $uniqueString = $url.'|'.$username.'|'.$password.'|'.($vaultGuid ?? 'default');
-
-        return 'm-files-auth-token:'.hash('sha256', $uniqueString);
-    }
-
-    /**
-     * Store the authentication token in cache
-     */
-    private static function storeInCache(string $cacheKey, self $token, string $cacheDriver): void
-    {
-        // Use the same expiration time from config for cache TTL
-        $ttl = config('m-files.auth.expiration', 3600);
-
-        // Ensure TTL is positive and reasonable
-        $ttl = max(300, min($ttl, 3600)); // Between 5 minutes and 1 hour
 
-        Cache::store($cacheDriver)->put($cacheKey, $token, $ttl);
+        $cacheManager = new CacheKeyManager($config);
+
+        return $cacheManager->rememberAuthToken(3600, function () use ($config) {
+            return new LogInToVaultRequest(
+                url: $config->url,
+                vaultGuid: $config->vaultGuid,
+                username: $config->username,
+                password: $config->password,
+                sessionId: Str::uuid()->toString()
+            )->send()->dto();
+        });
     }
 }