v1.1.0 (#14)

* Add generic rest endpoint class for calling custom endpoints

* fix doc string on rest endpoint

* code quality fixes

* code review: add types

* Abstract Custom Headers Setup + Add Unit Tests

* Fix Code Quality

* Update Code Quality on Filter Abstraction + Add All Filters to Filter Builder

* Add in PHP 8.4 PR Check

---------

Co-authored-by: achodoff-sugarcrm <77338571+achodoff-sugarcrm@users.noreply.github.com>

Author: MichaelJ2324

.github/workflows/pr-checks.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ['8.0','8.2','8.3']
+        php-versions: ['8.0','8.2','8.3', '8.4']
     steps:
     - uses: actions/checkout@v3
 

rector.php

@@ -14,7 +14,9 @@
         SimplifyEmptyCheckOnEmptyArrayRector::class,
     ])
     ->withSets([
-        SetList::PHP_80,
+        SetList::PHP_82,
+        SetList::PHP_83,
+        SetList::PHP_84,
         SetList::DEAD_CODE,
         SetList::CODE_QUALITY,
         SetList::CODING_STYLE,

src/Client/SugarApi.php

@@ -14,6 +14,7 @@
 use Sugarcrm\REST\Endpoint\MLPackage;
 use Sugarcrm\REST\Endpoint\ModuleLoader;
 use Sugarcrm\REST\Endpoint\Ping;
+use Sugarcrm\REST\Endpoint\Rest;
 use Sugarcrm\REST\Endpoint\Smart;
 use Sugarcrm\REST\Endpoint\SugarBean;
 use Sugarcrm\REST\Endpoint\ModuleFilter;
@@ -48,6 +49,7 @@
  * @method ModuleLoader moduleLoader() -
  * @method MLPackage mlp(string $id = null)
  * @method Integrate integrate(string $module = '', string $id = '')
+ * @method Rest rest(string $endpoint = '')
  */
 class SugarApi extends AbstractClient implements PlatformAwareInterface
 {

src/Endpoint/Abstracts/AbstractSmartSugarEndpoint.php

@@ -6,11 +6,13 @@
 
 namespace Sugarcrm\REST\Endpoint\Abstracts;
 
+use GuzzleHttp\Psr7\Request;
 use MRussell\REST\Endpoint\Data\ValidatedEndpointData;
 use MRussell\REST\Endpoint\SmartEndpoint;
 use MRussell\REST\Traits\PsrLoggerTrait;
 use Sugarcrm\REST\Endpoint\SugarEndpointInterface;
 use Sugarcrm\REST\Endpoint\Traits\CompileRequestTrait;
+use Sugarcrm\REST\Endpoint\Traits\CustomHeadersTrait;
 
 /**
  * Provide a smarter interface for Endpoints, to better manage passed in data
@@ -20,6 +22,12 @@ abstract class AbstractSmartSugarEndpoint extends SmartEndpoint implements Sugar
 {
     use CompileRequestTrait;
     use PsrLoggerTrait;
+    use CustomHeadersTrait;
 
     protected string $_dataInterface = ValidatedEndpointData::class;
+
+    protected function configureRequest(Request $request, $data): Request
+    {
+        return parent::configureRequest($this->addCustomHeadersToRequest($request), $data);
+    }
 }

src/Endpoint/Abstracts/AbstractSugarBeanCollectionEndpoint.php

@@ -6,8 +6,10 @@
 
 namespace Sugarcrm\REST\Endpoint\Abstracts;
 
+use GuzzleHttp\Psr7\Request;
 use Sugarcrm\REST\Endpoint\SugarBean;
 use MRussell\REST\Endpoint\Abstracts\AbstractModelEndpoint;
+use Sugarcrm\REST\Endpoint\Traits\CustomHeadersTrait;
 use Sugarcrm\REST\Endpoint\Traits\FieldsDataTrait;
 use Sugarcrm\REST\Endpoint\Traits\ModuleAwareTrait;
 
@@ -22,6 +24,7 @@ abstract class AbstractSugarBeanCollectionEndpoint extends AbstractSugarCollecti
 {
     use FieldsDataTrait;
     use ModuleAwareTrait;
+    use CustomHeadersTrait;
 
     public const SUGAR_ORDERBY_DATA_PROPERTY = 'order_by';
 
@@ -97,6 +100,11 @@ protected function configurePayload(): mixed
         return $this->configureFieldsDataProps($data);
     }
 
+    protected function configureRequest(Request $request, $data): Request
+    {
+        return parent::configureRequest($this->addCustomHeadersToRequest($request), $data);
+    }
+
     /**
      * Add module to url options
      * @inheritdoc

src/Endpoint/Abstracts/AbstractSugarBeanEndpoint.php

@@ -22,6 +22,7 @@
 use Sugarcrm\REST\Endpoint\Integrate;
 use Sugarcrm\REST\Endpoint\SugarEndpointInterface;
 use Sugarcrm\REST\Endpoint\Traits\CompileRequestTrait;
+use Sugarcrm\REST\Endpoint\Traits\CustomHeadersTrait;
 use Sugarcrm\REST\Endpoint\Traits\FieldsDataTrait;
 use Sugarcrm\REST\Endpoint\Traits\IntegrateSyncKeyTrait;
 use Sugarcrm\REST\Endpoint\Traits\ModuleAwareTrait;
@@ -53,6 +54,7 @@ abstract class AbstractSugarBeanEndpoint extends ModelEndpoint implements SugarE
     use FieldsDataTrait;
     use FileUploadsTrait;
     use IntegrateSyncKeyTrait;
+    use CustomHeadersTrait;
 
     public const MODEL_ACTION_VAR = 'action';
 
@@ -173,7 +175,7 @@ protected function configureRequest(Request $request, $data): Request
             $data = $this->configureFieldsDataProps($data);
         }
 
-        return parent::configureRequest($request, $data);
+        return parent::configureRequest($this->addCustomHeadersToRequest($request), $data);
     }
 
     /**

src/Endpoint/Abstracts/AbstractSugarCollectionEndpoint.php

@@ -6,13 +6,15 @@
 
 namespace Sugarcrm\REST\Endpoint\Abstracts;
 
+use GuzzleHttp\Psr7\Request;
 use MRussell\REST\Exception\Endpoint\InvalidRequest;
 use GuzzleHttp\Psr7\Response;
 use MRussell\REST\Endpoint\Data\AbstractEndpointData;
 use MRussell\REST\Endpoint\CollectionEndpoint;
 use MRussell\REST\Traits\PsrLoggerTrait;
 use Sugarcrm\REST\Endpoint\SugarEndpointInterface;
 use Sugarcrm\REST\Endpoint\Traits\CompileRequestTrait;
+use Sugarcrm\REST\Endpoint\Traits\CustomHeadersTrait;
 
 /**
  * Provides access to a multi-bean collection retrieved from Sugar 7 REST Api
@@ -23,6 +25,7 @@ abstract class AbstractSugarCollectionEndpoint extends CollectionEndpoint implem
 {
     use CompileRequestTrait;
     use PsrLoggerTrait;
+    use CustomHeadersTrait;
 
     public const SUGAR_OFFSET_PROPERTY = 'offset';
 
@@ -82,6 +85,11 @@ protected function configurePayload(): mixed
         return $data;
     }
 
+    protected function configureRequest(Request $request, $data): Request
+    {
+        return parent::configureRequest($this->addCustomHeadersToRequest($request), $data);
+    }
+
     /**
      * Get the configured offset
      */

src/Endpoint/Abstracts/AbstractSugarEndpoint.php

@@ -6,10 +6,12 @@
 
 namespace Sugarcrm\REST\Endpoint\Abstracts;
 
+use GuzzleHttp\Psr7\Request;
 use MRussell\REST\Endpoint\Endpoint;
 use MRussell\REST\Traits\PsrLoggerTrait;
 use Sugarcrm\REST\Endpoint\SugarEndpointInterface;
 use Sugarcrm\REST\Endpoint\Traits\CompileRequestTrait;
+use Sugarcrm\REST\Endpoint\Traits\CustomHeadersTrait;
 
 /**
  * Base Sugar API Endpoint for the simplest of REST functionality
@@ -19,4 +21,10 @@ abstract class AbstractSugarEndpoint extends Endpoint implements SugarEndpointIn
 {
     use CompileRequestTrait;
     use PsrLoggerTrait;
+    use CustomHeadersTrait;
+
+    protected function configureRequest(Request $request, $data): Request
+    {
+        return parent::configureRequest($this->addCustomHeadersToRequest($request), $data);
+    }
 }

src/Endpoint/Data/Filters/AbstractPredefinedFilter.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Sugarcrm\REST\Endpoint\Data\Filters;
+
+use Sugarcrm\REST\Endpoint\Data\Filters\Operator\AbstractOperator;
+
+abstract class AbstractPredefinedFilter extends AbstractOperator
+{
+    public function __construct(array $arguments = [])
+    {
+        if (!empty($arguments) && count($arguments) < 2) {
+            $arguments = [
+                $this->getOperator(),
+                $arguments[0] ?? '',
+            ];
+        }
+
+        parent::__construct($arguments);
+    }
+
+    public function compile(): array
+    {
+        return [
+            $this->getOperator() => $this->getValue(),
+        ];
+    }
+}

src/Endpoint/Data/Filters/Creator.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Sugarcrm\REST\Endpoint\Data\Filters;
+
+class Creator extends AbstractPredefinedFilter
+{
+    public const OPERATOR = '$creator';
+}