Merge pull request #105 from codebar-ag/feature-readme

Feature readme.md update

Author: StanBarrows

README.md

@@ -95,7 +95,7 @@ $config = Config::make([
     'request_timeout_in_seconds' => 15,
 ]);
 
-$connector = new DocuWareStaticConnector($config);
+$connector = new DocuWareDynamicConnector($config);
 
 /**
  * Return an organization.
@@ -518,6 +518,11 @@ logout with DocuWare:
 ```php
 use CodebarAg\DocuWare\Facades\DocuWare;
 
+/**
+ * Receive a cookie
+ */
+DocuWare::cookie(string $url, string $username, string $password);
+
 /**
  * Login with your credentials. You only need to login once. Afterwards the
  * authentication cookie is stored in the cache as `docuware.cookies` and
@@ -580,7 +585,6 @@ $request->disableCaching();
 $response = $connector->send($request);
 ```
 
-
 ## 💥 Exceptions explained
 
 - `CodebarAg\DocuWare\Exceptions\UnableToMakeRequest`

src/DTO/Cookie.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace CodebarAg\DocuWare\DTO;
+
+use CodebarAg\DocuWare\Exceptions\UnableToLoginNoCookies;
+use GuzzleHttp\Cookie\CookieJar;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Carbon;
+
+final class Cookie
+{
+    public function __construct(
+        public string $cookie,
+        public Carbon $cookie_created_at,
+        public Carbon $cookie_lifetime_until,
+    ) {
+    }
+
+    public static function make(CookieJar $cookieJar): self
+    {
+        throw_if($cookieJar->toArray() === [], UnableToLoginNoCookies::create());
+
+        $data = collect($cookieJar->toArray())
+            ->reject(fn (array $cookie) => Arr::get($cookie, 'Value') === '')
+            ->firstWhere('Name', '.DWPLATFORMAUTH');
+
+        $now = now();
+
+        return new self(
+            cookie: Arr::get($data, 'Value'),
+            cookie_created_at: $now,
+            cookie_lifetime_until: $now->addSeconds(525600 * 0.75),
+        );
+    }
+}

src/DocuWare.php

@@ -2,16 +2,50 @@
 
 namespace CodebarAg\DocuWare;
 
+use CodebarAg\DocuWare\DTO\Cookie;
 use CodebarAg\DocuWare\Events\DocuWareResponseLog;
 use CodebarAg\DocuWare\Requests\Auth\GetLogoffRequest;
+use CodebarAg\DocuWare\Requests\Auth\PostLoginRequest;
 use CodebarAg\DocuWare\Support\Auth;
 use CodebarAg\DocuWare\Support\EnsureValidCookie;
 use CodebarAg\DocuWare\Support\EnsureValidCredentials;
+use CodebarAg\DocuWare\Support\EnsureValidResponse;
+use GuzzleHttp\Cookie\CookieJar;
 use Saloon\Exceptions\InvalidResponseClassException;
 use Saloon\Exceptions\PendingRequestException;
 
 class DocuWare
 {
+    /**
+     * @throws InvalidResponseClassException
+     * @throws \Throwable
+     * @throws \ReflectionException
+     * @throws PendingRequestException
+     */
+    public function cookie(string $url, string $username, string $password, $rememberMe = false, $redirectToMyselfInCaseOfError = false, $licenseType = null): Cookie
+    {
+        $cookieJar = new CookieJar();
+
+        $request = new PostLoginRequest(
+            $url,
+            $username,
+            $password,
+            $rememberMe,
+            $redirectToMyselfInCaseOfError,
+            $licenseType);
+
+        $request->config()->add('cookies', $cookieJar);
+
+        $response = $request->send();
+
+        event(new DocuWareResponseLog($response));
+
+        EnsureValidResponse::from($response);
+
+        return Cookie::make($cookieJar);
+
+    }
+
     /**
      * @throws InvalidResponseClassException
      * @throws \Throwable
@@ -21,7 +55,6 @@ class DocuWare
     public function login(): void
     {
         EnsureValidCredentials::check();
-
         // Checks if already logged in, if not, logs in
         EnsureValidCookie::check();
     }

src/Facades/DocuWare.php

@@ -5,6 +5,7 @@
 use Carbon\Carbon;
 use CodebarAg\DocuWare\DocuWareSearchRequestBuilder;
 use CodebarAg\DocuWare\DocuWareUrl;
+use CodebarAg\DocuWare\DTO\Cookie;
 use CodebarAg\DocuWare\DTO\Dialog;
 use CodebarAg\DocuWare\DTO\Document;
 use CodebarAg\DocuWare\DTO\DocumentThumbnail;
@@ -18,7 +19,7 @@
 /**
  * @see \CodebarAg\DocuWare\DocuWare
  *
- * @method static self cookie()
+ * @method static Cookie cookie(string $url, string $username, string $password, $rememberMe = false, $redirectToMyselfInCaseOfError = false, $licenseType = null)
  * @method static string login()
  * @method static void logout()
  * @method static Organization getOrganization(string $organizationId)

src/Requests/Auth/PostLoginRequest.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace CodebarAg\DocuWare\Requests\Auth;
+
+use CodebarAg\DocuWare\Events\DocuWareResponseLog;
+use CodebarAg\DocuWare\Support\EnsureValidResponse;
+use Saloon\Contracts\Body\HasBody;
+use Saloon\Contracts\Response;
+use Saloon\Enums\Method;
+use Saloon\Http\SoloRequest;
+use Saloon\Traits\Body\HasFormBody;
+
+class PostLoginRequest extends SoloRequest implements HasBody
+{
+    use HasFormBody;
+
+    protected Method $method = Method::POST;
+
+    public function __construct(
+        protected readonly string $url,
+        protected readonly string $username,
+        protected readonly string $password,
+        protected readonly bool $rememberMe = false,
+        protected readonly bool $redirectToMyselfInCaseOfError = false,
+        protected readonly ?string $licenseType = null,
+    ) {
+    }
+
+    public function resolveEndpoint(): string
+    {
+        return $this->url.'/DocuWare/Platform/Account/Logon';
+    }
+
+    protected function defaultBody(): array
+    {
+        return [
+            'UserName' => $this->username,
+            'Password' => $this->password,
+            'RememberMe' => $this->rememberMe,
+            'RedirectToMyselfInCaseOfError' => $this->redirectToMyselfInCaseOfError,
+            'LicenseType' => $this->licenseType,
+        ];
+    }
+
+    public function createDtoFromResponse(Response $response): Response
+    {
+        event(new DocuWareResponseLog($response));
+
+        EnsureValidResponse::from($response);
+
+        return $response;
+    }
+}

src/Responses/FileCabinets/GetFileCabinetsResponse.php

@@ -17,7 +17,7 @@ public static function fromResponse(Response $response): Collection|Enumerable
 
         EnsureValidResponse::from($response);
 
-        $cabinets = $response->throw()->json('FileCabinet');
+        $cabinets = $response->throw()->body();
 
         return collect($cabinets)->map(fn (array $cabinet) => FileCabinet::fromJson($cabinet));
     }

src/Support/EnsureValidCookie.php

@@ -23,7 +23,7 @@ public static function check(): void
 
         EnsureValidCredentials::check();
 
-        event(new DocuWareCookieCreatedLog('Creating new authenticaion cookie for caching'));
+        event(new DocuWareCookieCreatedLog('Creating new authentication cookie for caching'));
 
         $cookieJar = new CookieJar();
 

tests/Feature/Facades/DocuWare/CookieTest.php

@@ -0,0 +1,15 @@
+<?php
+
+use CodebarAg\DocuWare\Facades\DocuWare;
+
+uses()->group('docuware');
+
+it('cookie method', function () {
+
+    $url = config('docuware.credentials.url');
+    $username = config('docuware.credentials.username');
+    $password = config('docuware.credentials.password');
+
+    $cookie = DocuWare::cookie($url, $username, $password);
+    expect($cookie)->not()->toBeEmpty();
+});