Test Coverage + ModuleLoader API finalization

Author: MichaelJ2324

composer.json

@@ -20,7 +20,7 @@
   ],
   "require": {
     "php": ">=8.0",
-    "michaelj2324/php-rest-client": "^3.0"
+    "michaelj2324/php-rest-client": ">=3.0.2"
   },
   "require-dev": {
     "phpunit/phpunit": "9.*",

examples/Bulk.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * ©[2024] SugarCRM Inc.  Licensed by SugarCRM under the Apache 2.0 license.
+ */
+
+require_once 'include.php';
+
+$SugarAPI = new \Sugarcrm\REST\Client\SugarApi($server, $credentials);
+try {
+    if ($SugarAPI->isAuthenticated()) {
+        $lead1 = $SugarAPI->module("Leads");
+        $lead2 = $SugarAPI->module("Leads");
+        $lead1['first_name'] = "Test";
+        $lead1['last_name'] = "Lead";
+
+        //Set same data on Lead 2
+        $lead2->set($lead1->toArray());
+        //Add 2 to second lead last name to differentiate
+        $lead2['last_name'] .= "2";
+        //Set
+        $lead1->setCurrentAction(\MRussell\REST\Endpoint\ModelEndpoint::MODEL_ACTION_CREATE);
+        $lead2->setCurrentAction(\MRussell\REST\Endpoint\ModelEndpoint::MODEL_ACTION_CREATE);
+        $bulk = $SugarAPI->bulk();
+        $bulk->setData([
+            $lead1,
+            $lead2,
+        ]);
+        echo json_encode($bulk->getData()->toArray(), JSON_PRETTY_PRINT);
+        $bulk->execute();
+        echo json_encode($bulk->getResponseContent(), JSON_PRETTY_PRINT);
+    } else {
+        echo "Could not login.";
+        pre($SugarAPI->getAuth()->getActionEndpoint('authenticate')->getResponse());
+    }
+} catch (Exception $ex) {
+    echo "Error Occurred: ";
+    pre($ex->getMessage());
+    pre($ex->getTraceAsString());
+}

src/Endpoint/Abstracts/AbstractSugarBeanEndpoint.php

@@ -134,7 +134,7 @@ public function __construct(array $urlArgs = [], array $properties = [])
     {
         parent::__construct($urlArgs, $properties);
         foreach (static::$_DEFAULT_SUGAR_BEAN_ACTIONS as $action => $method) {
-            $this->actions[$action] = $method;
+            $this->_actions[$action] = $method;
         }
     }
 
@@ -473,7 +473,7 @@ public function filterRelated(string $linkName, bool $count = false): FilterData
             $args[] = 'count';
         }
 
-        $this->configureAction($this->action, $args);
+        $this->configureAction($this->_action, $args);
         return $Filter;
     }
 

src/Endpoint/MLPackage.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Sugarcrm\REST\Endpoint;
+
+class MLPackage extends SugarBean
+{
+    public const ACTION_INSTALL = 'install';
+
+    public const ACTION_UNINSTALL = 'uninstall';
+
+    public const ACTION_ENABLE = 'enable';
+
+    public const ACTION_DISABLE = 'disable';
+
+    public const ACTION_INSTALL_STATUS = 'installation-status';
+
+    protected static array $_DEFAULT_PROPERTIES = [
+        self::PROPERTY_URL => 'Administration/packages/$id/$:action',
+        self::PROPERTY_AUTH => true,
+    ];
+
+    protected static array $_DEFAULT_SUGAR_BEAN_ACTIONS = [
+        self::ACTION_INSTALL => 'GET',
+        self::ACTION_UNINSTALL => 'GET',
+        self::ACTION_ENABLE => 'GET',
+        self::ACTION_DISABLE => 'GET',
+        self::ACTION_INSTALL_STATUS => 'GET',
+    ];
+
+    /**
+     * Setup the query params passed during File Uploads
+     * @codeCoverageIgnore
+     */
+    protected function configureFileUploadQueryParams(): array
+    {
+        return [];
+    }
+}

src/Endpoint/Me.php

@@ -66,7 +66,7 @@ public function __construct(array $urlArgs = [], array $properties = [])
     {
         parent::__construct($urlArgs, $properties);
         foreach (static::$_DEFAULT_SUGAR_USER_ACTIONS as $action => $method) {
-            $this->actions[$action] = $method;
+            $this->_actions[$action] = $method;
         }
     }
 
@@ -115,7 +115,7 @@ protected function configureAction(string $action, array $arguments = []): void
                 case self::USER_ACTION_DELETE_PREFERENCE:
                 case self::USER_ACTION_CREATE_PREFERENCE:
                     if (isset($arguments[0])) {
-                        $this->urlArgs['actionArg1'] = $arguments[0];
+                        $this->_urlArgs['actionArg1'] = $arguments[0];
                     }
             }
         }

src/Endpoint/ModuleLoader.php

@@ -2,36 +2,69 @@
 
 namespace Sugarcrm\REST\Endpoint;
 
-class ModuleLoader extends SugarBean
-{
-    public const ACTION_INSTALL = 'install';
-
-    public const ACTION_UNINSTALL = 'uninstall';
+use MRussell\REST\Endpoint\CollectionEndpoint;
 
-    public const ACTION_ENABLE = 'enable';
+class ModuleLoader extends CollectionEndpoint
+{
+    public const URL_ARG_FILTER = 'filter';
 
-    public const ACTION_DISABLE = 'disable';
+    public const FILTER_STAGED = 'staged';
 
-    public const ACTION_INSTALL_STATUS = 'installation-status';
+    public const FILTER_INSTALLED = 'installed';
 
     protected static array $_DEFAULT_PROPERTIES = [
-        self::PROPERTY_URL => 'Administration/packages/$id/$:action',
-        self::PROPERTY_AUTH => true,
+        self::PROPERTY_URL => 'Administration/packages/$:filter',
+        self::PROPERTY_RESPONSE_PROP => 'packages',
+        self::PROPERTY_HTTP_METHOD => 'GET',
+        self::PROPERTY_AUTH => true
     ];
 
-    protected static array $_DEFAULT_SUGAR_BEAN_ACTIONS = [
-        self::ACTION_INSTALL => 'GET',
-        self::ACTION_UNINSTALL => 'GET',
-        self::ACTION_ENABLE => 'GET',
-        self::ACTION_DISABLE => 'GET',
-        self::ACTION_INSTALL_STATUS => 'GET',
-    ];
+    protected string $_modelInterface = MLPackage::class;
+
+    protected string $_filter = '';
+
+    public function setUrlArgs(array $args): static
+    {
+        if (!empty($args[0])) {
+            $this->_filter = $args[0];
+            unset($args[0]);
+        }
+        if (!empty($args[self::URL_ARG_FILTER])) {
+            $this->_filter = $args[self::URL_ARG_FILTER];
+            unset($args[self::URL_ARG_FILTER]);
+        }
+        return parent::setUrlArgs($args);
+    }
+
+    protected function configureURL(array $urlArgs): string
+    {
+        if (!empty($this->_filter)) {
+            $urlArgs[self::URL_ARG_FILTER] = $this->_filter;
+        }
+        return parent::configureURL($urlArgs);
+    }
+
+    public function execute(array $options = []): static
+    {
+        parent::execute($options);
+        $this->_filter = '';
+        return $this;
+    }
+
+    public function staged(): static
+    {
+        $this->_filter = self::FILTER_STAGED;
+        return $this->execute();
+    }
+
+    public function installed(): static
+    {
+        $this->_filter = self::FILTER_INSTALLED;
+        return $this->execute();
+    }
 
-    /**
-     * Setup the query params passed during File Uploads
-     */
-    protected function configureFileUploadQueryParams(): array
+    public function newPackage(): MLPackage
     {
-        return [];
+        return $this->generateEndpoint(MLPackage::class);
     }
 }

src/Endpoint/Note.php

@@ -26,7 +26,7 @@ class Note extends SugarBean
 
     public const NOTES_ATTACHMENTS_FIELD = 'attachments';
 
-    protected array $actions = [
+    protected array $_actions = [
         self::NOTE_ACTION_MULTI_ATTACH => 'POST',
     ];
 

src/Endpoint/Packages.php

@@ -11,6 +11,8 @@
 use Sugarcrm\REST\Auth\SugarOAuthController;
 use Sugarcrm\REST\Endpoint\AuditLog;
 use Sugarcrm\REST\Endpoint\Email;
+use Sugarcrm\REST\Endpoint\MLPackage;
+use Sugarcrm\REST\Endpoint\ModuleLoader;
 use Sugarcrm\REST\Endpoint\SugarBean;
 use Sugarcrm\REST\Endpoint\ModuleFilter;
 use Sugarcrm\REST\Endpoint\Search;
@@ -143,5 +145,15 @@ class SugarEndpointProvider extends VersionedEndpointProvider
             self::ENDPOINT_CLASS => Email::class,
             self::ENDPOINT_PROPERTIES => [],
         ],
+        [
+            self::ENDPOINT_NAME => 'moduleLoader',
+            self::ENDPOINT_CLASS => ModuleLoader::class,
+            self::ENDPOINT_PROPERTIES => [],
+        ],
+        [
+            self::ENDPOINT_NAME => 'mlp',
+            self::ENDPOINT_CLASS => MLPackage::class,
+            self::ENDPOINT_PROPERTIES => [],
+        ]
     ];
 }

src/Endpoint/Provider/SugarEndpointProvider.php

@@ -41,7 +41,7 @@ public function testConstruct(): void
     {
         $Me = new Me();
         $Reflection = new \ReflectionClass($Me::class);
-        $actions = $Reflection->getProperty('actions');
+        $actions = $Reflection->getProperty('_actions');
         $actions->setAccessible(true);
         $this->assertNotEmpty(
             $actions->getValue($Me),
@@ -58,7 +58,7 @@ public function testConfigureUrl(): void
         $configureUrl = $Reflection->getMethod('configureURL');
         $configureUrl->setAccessible(true);
 
-        $action = $Reflection->getProperty('action');
+        $action = $Reflection->getProperty('_action');
         $action->setAccessible(true);
 
         $this->assertEquals('me', $configureUrl->invoke($Me, []));