Merge branch 'master' of https://github.com/docusign/code-examples-php-private

Author: karissarjacobsen

README.md

@@ -6,6 +6,14 @@
 >
 ### GitHub repo: [code-examples-php](./README.md)
 
+If you downloaded this project using the [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) tool, it may be configured in one of three ways:
+
+* **[JWT Grant remote signing example](#jwt-grant-remote-signing-example)**–demonstrates how to implement JSON Web Token authentication. It includes a single remote signing workflow.
+* **[Authorization Code Grant embedded signing example](#authorization-code-grant-embedded-signing-example)**–demonstrates how to implement Authorization Code Grant authentication. It includes a single embedded signing workflow.
+* **[Multiple code examples, Authorization Code Grant and JWT Grant](#installation-steps)**–includes the full range of examples and authentication types.
+
+***Installation and running instructions vary depending on the configuration. Follow the link that matches your project type to get started.***
+
 This GitHub repo includes code examples for the [Web Forms API](https://developers.docusign.com/docs/web-forms-api/), [Maestro API](https://developers.docusign.com/docs/maestro-api/), [Docusign Admin API](https://developers.docusign.com/docs/admin-api/), [Click API](https://developers.docusign.com/docs/click-api/), [eSignature REST API](https://developers.docusign.com/docs/esign-rest-api/), [Monitor API](https://developers.docusign.com/docs/monitor-api/), and [Rooms API](https://developers.docusign.com/docs/rooms-api/). 
 
 
@@ -200,6 +208,23 @@ Apache will run.
 ## JWT grant remote signing and Authorization Code Grant embedded signing projects
 See [Docusign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the Docusign Developer Center for more information on how to run the JWT grant remote signing and the Authorization Code Grant embedded signing project.
 
+### Authorization Code Grant embedded signing example:
+Run in Git Bash:
+```
+$ cd <Quickstart folder>/Quick_ACG
+$ composer install
+$ php -S localhost:8080
+```
+
+Open a browser to http://localhost:3000
+
+### JWT grant remote signing example:
+Run in Git Bash:
+```
+$ cd <Quickstart folder>/JWT Console App
+$ composer install
+$ php JWTConsoleApp.php
+```
 
 ## Payments code example  
 

composer.json

@@ -23,7 +23,6 @@
     "docusign/rooms-client": "^2.1.1",
     "docusign/monitor-client": "^1.2.1",
     "docusign/webforms-client": "^1.0.1-rc1",
-    "docusign/maestro-client": "v2.0.0-rc1",
     "twig/twig": "^3.14.0",
     "league/oauth2-client": "^2.7.0",
     "ext-json": "*",

public/assets/search.js

@@ -6,8 +6,10 @@ let DS_SEARCH = (function () {
         ROOMS: 'rooms',
         ADMIN: 'admin',
         CONNECT: 'connect',
+        WEBFORMS: 'webforms',
+        NOTARY: 'notary',
         MAESTRO: 'maestro',
-        WEBFORMS: 'webforms'
+        CONNECTEDFIELDS: 'connectedfields',
     };
 
     let processJSONData = function () {
@@ -127,10 +129,14 @@ let DS_SEARCH = (function () {
                 return "eg";
             case API_TYPES.CONNECT:
                 return "con";
-            case API_TYPES.MAESTRO:
-                return "mae";
             case API_TYPES.WEBFORMS:
                 return "web";
+            case API_TYPES.NOTARY:
+                return "n";
+            case API_TYPES.CONNECTEDFIELDS:
+                return "cf";
+            case API_TYPES.MAESTRO:
+                return "mae";
         }
     }
 

src/Controllers/Auth/DocuSign.php

@@ -122,14 +122,18 @@ public function getDefaultScopes(): array
                 . " asset_group_account_clone_write asset_group_account_clone_read "
                 . "organization_sub_account_write organization_sub_account_read"
             ];
-        } elseif ($_SESSION['api_type'] == ApiTypes::MAESTRO) {
-            return [
-                "signature aow_manage"
-            ];
         } elseif ($_SESSION['api_type'] == ApiTypes::WEBFORMS) {
             return [
                 "signature webforms_read webforms_instance_read webforms_instance_write"
             ];
+        } elseif ($_SESSION['api_type'] == ApiTypes::NOTARY) {
+            return [
+                "signature"
+            ];
+        } elseif ($_SESSION['api_type'] == ApiTypes::CONNECTEDFIELDS) {
+            return [
+                "signature adm_store_unified_repo_read"
+            ];
         } else {
             return [
                 "signature"

src/Controllers/MaestroApiBaseController.php renamed to src/Controllers/ConnectedFieldsApiBaseController.php

@@ -2,22 +2,23 @@
 
 namespace DocuSign\Controllers;
 
+use DocuSign\Services\SignatureClientService;
+use DocuSign\Services\RouterService;
+use DocuSign\Services\IRouterService;
 use DocuSign\Services\ApiTypes;
 use DocuSign\Services\ManifestService;
-use DocuSign\Services\MaestroApiClientService;
-use DocuSign\Services\RouterService;
 
-abstract class MaestroApiBaseController extends BaseController
+abstract class ConnectedFieldsApiBaseController extends BaseController
 {
     private const MINIMUM_BUFFER_MIN = 3;
-    protected MaestroApiClientService $clientService;
-    protected RouterService $routerService;
+    protected SignatureClientService $clientService;
+    protected IRouterService $routerService;
     protected array $args;
 
     public function __construct()
     {
         $this->args = $this->getTemplateArgs();
-        $this->clientService = new MaestroApiClientService($this->args);
+        $this->clientService = new SignatureClientService($this->args);
         $this->routerService = new RouterService();
         if (defined("static::EG")) {
             $this->checkDsToken();
@@ -29,87 +30,100 @@ abstract protected function getTemplateArgs(): array;
     /**
      * Base controller
      *
-     * @param $args array|null
+     * @param null $eg
      * @return void
      */
-    public function controller(array $args = null): void
+    public function controller($args = null): void
     {
+        if (empty($eg)) {
+            $eg = static::EG;
+            $this->codeExampleText = $this->getPageText(static::EG);
+        }
+
         $this->codeExampleText = $this->getPageText(static::EG);
 
         if ($this->isMethodGet()) {
-            $this->getController($this->routerService, basename(static::FILE), $args);
+            $this->getController(
+                $args,
+                basename(static::FILE)
+            );
         }
+
         if ($this->isMethodPost()) {
-            $this->routerService->checkCsrf();
             $this->createController();
         }
     }
 
     /**
      * Show the example's form page
      *
-     * @param $routerService RouterService
+     * @param $eg
      * @param $basename string|null
-     * @param $args array|null
+     * @param $brand_languages array|null
+     * @param $brands array|null
+     * @param $permission_profiles array|null
+     * @param $groups array|null
      * @return void
      */
-    private function getController(
-        RouterService $routerService,
-        ?string $basename,
-        ?array $args
+    protected function getController(
+        $args,
+        ?string $basename
     ): void {
         if ($this->isHomePage(static::EG)) {
-            $GLOBALS['twig']->display(
-                static::EG . '.html',
-                [
-                    'title' => $this->homePageTitle(static::EG),
-                    'show_doc' => false,
-                    'common_texts' => $this->getCommonText()
-                ]
-            );
+            $GLOBALS['twig']->display(static::EG . '.html', [
+                'title' => $this->homePageTitle(static::EG),
+                'show_doc' => false,
+                'common_texts' => $this->getCommonText()
+            ]);
         } else {
             $currentAPI = ManifestService::getAPIByLink(static::EG);
-            if ($routerService->dsTokenOk() && $currentAPI === $_SESSION['api_type']) {
-                $GLOBALS['twig']->display($routerService->getTemplate(static::EG), [
-                    'title' => $routerService->getTitle(static::EG),
+            if ($this->routerService->dsTokenOk() && $currentAPI === $_SESSION['api_type']) {
+                $displayOptions = [
+                    'title' => $this->routerService->getTitle(static::EG),
                     'source_file' => $basename,
-                    'source_url' => $GLOBALS['DS_CONFIG']['github_example_url']  . "/Maestro/" . $basename,
+                    'args' => $args,
+                    'source_url' => $GLOBALS['DS_CONFIG']['github_example_url'] . "/ConnectedFields/".  $basename,
                     'documentation' => $GLOBALS['DS_CONFIG']['documentation'] . static::EG,
                     'show_doc' => $GLOBALS['DS_CONFIG']['documentation'],
-                    'args' => $args,
-                    'template_id' =>  $_COOKIE["template_id"],
-                    'workflow_id' =>  $_SESSION["workflow_id"],
-                    'instance_id' =>  $_SESSION['instance_id'],
                     'signer_name' => $GLOBALS['DS_CONFIG']['signer_name'],
                     'signer_email' => $GLOBALS['DS_CONFIG']['signer_email'],
                     'code_example_text' => $this->codeExampleText,
                     'common_texts' => $this->getCommonText()
-                ]);
+                ];
+
+                $GLOBALS['twig']->display($this->routerService->getTemplate(static::EG), $displayOptions);
             } else {
-                # Save the current operation so it will be resumed after authentication
-                $_SESSION['prefered_api_type'] = ApiTypes::MAESTRO;
-                $_SESSION['eg'] = $GLOBALS['app_url'] . 'index.php?page=' . static::EG;
+                $_SESSION['prefered_api_type'] = ApiTypes::CONNECTEDFIELDS;
+                $this->saveCurrentUrlToSession(static::EG);
                 header('Location: ' . $GLOBALS['app_url'] . 'index.php?page=' . static::LOGIN_REDIRECT);
                 exit;
             }
         }
     }
-    
+
     /**
      * Declaration for the base controller creator. Each creator should be described in specific Controller
      */
     abstract protected function createController(): void;
 
     /**
-     * @return array
+     * Check email input value using regular expression
+     * @param $email
+     * @return string
+     */
+    protected function checkEmailInputValue($email): string
+    {
+        return preg_replace('/([^\w +\-\@\.\,])+/', '', $email);
+    }
+
+    /**
+     * Check input values using regular expressions
+     * @param $value
+     * @return string
      */
-    protected function getDefaultTemplateArgs(): array
+    protected function checkInputValues($value): string
     {
-        return [
-            'account_id' => $_SESSION['ds_account_id'],
-            'base_path' => $_SESSION['ds_base_path'], // here
-            'ds_access_token' => $_SESSION['ds_access_token']
-        ];
+        return preg_replace('/([^\w \-\@\.\,])+/', '', $value);
     }
 
     /**
@@ -118,20 +132,10 @@ protected function getDefaultTemplateArgs(): array
     protected function checkDsToken(): void
     {
         $currentAPI = ManifestService::getAPIByLink(static::EG);
-
+        
         if (!$this->routerService->dsTokenOk(self::MINIMUM_BUFFER_MIN) || $currentAPI !== $_SESSION['api_type']) {
-            $_SESSION['prefered_api_type'] = ApiTypes::MAESTRO;
+            $_SESSION['prefered_api_type'] = ApiTypes::CONNECTEDFIELDS;
             $this->clientService->needToReAuth(static::EG);
         }
     }
-    
-    /**
-     * Check input values using regular expressions
-     * @param $value
-     * @return string
-     */
-    protected function checkInputValues($value): string
-    {
-        return preg_replace('/([^\w \-\@\.\,])+/', '', $value);
-    }
 }