Add generic rest endpoint class for calling custom endpoints

Author: achodoff-sugarcrm

src/Endpoint/Provider/SugarEndpointProvider.php

@@ -24,6 +24,7 @@
 use Sugarcrm\REST\Endpoint\Ping;
 use Sugarcrm\REST\Endpoint\Note;
 use Sugarcrm\REST\Endpoint\Generic;
+use Sugarcrm\REST\Endpoint\Rest;
 use Sugarcrm\REST\Endpoint\Smart;
 
 /**
@@ -161,5 +162,10 @@ class SugarEndpointProvider extends VersionedEndpointProvider
             self::ENDPOINT_CLASS => Integrate::class,
             self::ENDPOINT_PROPERTIES => [],
         ],
+        [
+            self::ENDPOINT_NAME => 'rest',
+            self::ENDPOINT_CLASS => Rest::class,
+            self::ENDPOINT_PROPERTIES => [],
+        ]
     ];
 }

src/Endpoint/Rest.php

@@ -0,0 +1,94 @@
+<?php
+/**
+ * ©[2022] SugarCRM Inc.  Licensed by SugarCRM under the Apache 2.0 license.
+ */
+
+namespace Sugarcrm\REST\Endpoint;
+
+use GuzzleHttp\Psr7\Request;
+use Sugarcrm\REST\Endpoint\Abstracts\AbstractSugarEndpoint;
+
+/**
+ * Generic REST endpoint allowing for querying custom endpoints
+ * usage examples:
+ * $client->rest('custom/endpoint')->get();
+ * $client->rest('custom/endpoint')->post($data);
+ * $client->rest('custom/endpoint')->put($data);
+ * $client->rest('custom/endpoint')->delete();
+ * $client->rest('custom/endpoint')->patch($data);
+ * $client->rest('custom/endpoint')->withHeaders($headers)->get();
+ * $client->rest('Contacts')->setData(['fields' => 'id,first_name,last_name', 'max_num' => 1])->get();
+ * etc.
+ * @package Sugarcrm\REST\Endpoint
+ */
+class Rest extends Generic
+{
+    protected static array $_DEFAULT_PROPERTIES = array(
+        self::PROPERTY_URL => '$endpoint',
+        self::PROPERTY_AUTH => true,
+        self::PROPERTY_HTTP_METHOD => "GET"
+    );
+
+    protected array $headers = [];
+
+    public function withHeaders(array $headers)
+    {
+        $this->headers = $headers;
+        return $this;
+    }
+
+    protected function configureRequest(Request $request, $data): Request
+    {
+        $request = parent::configureRequest($request, $data);
+
+        if (!empty($this->headers)) {
+            foreach ($this->headers as $header => $value) {
+                $request = $request->withHeader($header, $value);
+            }
+        }
+        return $request;
+    }
+
+    public function get($data = null)
+    {
+        $this->setProperty(self::PROPERTY_HTTP_METHOD, 'GET');
+        if (!is_null($data)) {
+            $this->setData($data);
+        }
+        return $this->execute();
+    }
+
+    public function post($data = null)
+    {
+        $this->setProperty(self::PROPERTY_HTTP_METHOD, 'POST');
+        if (!is_null($data)) {
+            $this->setData($data);
+        }
+        return $this->execute();
+    }
+
+    public function put($data = null)
+    {
+        $this->setProperty(self::PROPERTY_HTTP_METHOD, 'PUT');
+        if (!is_null($data)) {
+            $this->setData($data);
+        }
+        return $this->execute();
+    }
+
+    public function delete()
+    {
+        $this->setProperty(self::PROPERTY_HTTP_METHOD, 'DELETE');
+        return $this->execute();
+    }
+
+    public function patch($data = null)
+    {
+        $this->setProperty(self::PROPERTY_HTTP_METHOD, 'PATCH');
+        if (!is_null($data)) {
+            $this->setData($data);
+        }
+        return $this->execute();
+    }
+
+}