Merge branch 'master' into feature/add-maestro-examples

# Conflicts:
#	src/main/java/com/docusign/DSConfiguration.java
#	src/main/java/com/docusign/common/ApiIndex.java
#	src/main/resources/application.example.json
#	src/main/resources/public/assets/search.js
#	src/main/webapp/WEB-INF/templates/views/pages/esignature/index.jsp

Author: annahileta

README.md

@@ -59,6 +59,15 @@ For information about the scopes used for obtaining authorization to use the Adm
 For a list of code examples that use the Admin API, see the [How-to guides overview](https://developers.docusign.com/docs/admin-api/how-to/) on the DocuSign Developer Center.
 
 
+## Web Forms API
+
+The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact [DocuSign Support](https://support.docusign.com/) or your account manager to find out whether the Web Forms API is available for your production account plan.
+
+For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/web-forms-api/plan-integration/authentication/).
+
+For a list of code examples that use the Web Forms API, see the [How-to guides overview](https://developers.docusign.com/docs/web-forms-api/how-to/) on the DocuSign Developer Center.
+
+
 ## Installation
 
 ### Prerequisites

azure-pipelines.yml

@@ -48,7 +48,7 @@ steps:
   name: tests_config_properties
   displayName: 'download config.properties'
   inputs:
-    secureFile: 'java-php.config.properties'
+    secureFile: 'java.config.properties'
 
 
 - script: |
@@ -110,4 +110,13 @@ steps:
 - script: |
     docker stop $(docker ps -a -q)
     docker rm $(docker ps -a -q)
-  displayName: 'stop java app'
+  displayName: 'stop java app'
+
+- script: |
+    allure generate --clean --output $(Build.SourcesDirectory)/java-allure-output '$(Build.SourcesDirectory)/launcher-automation/target/allure-results'
+  displayName: generate allure html reports
+
+- task: PublishAllureReport@1
+  displayName: 'Publish Allure Report'
+  inputs:
+    reportDir: '$(Build.SourcesDirectory)/java-allure-output'

pom.xml

@@ -31,12 +31,12 @@
         <click.version> 1.4.0</click.version>
         <monitor.version>1.3.0</monitor.version>
         <admin.version>1.3.0</admin.version>
+        <webforms.version>1.0.2-RC12</webforms.version>
         <swagger-core-version>2.2.8</swagger-core-version>
         <jackson-version>2.14.2</jackson-version>
         <jersey2.version>3.0.9</jersey2.version>
     </properties>
 
-
     <dependencies>
         <dependency>
             <groupId>org.springframework.boot</groupId>
@@ -188,6 +188,12 @@
             <classifier>shaded</classifier>
         </dependency>
 
+        <dependency>
+            <groupId>com.docusign</groupId>
+            <artifactId>docusign-webforms-java</artifactId>
+            <version>${webforms.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-autoconfigure</artifactId>

src/main/java/com/docusign/DSConfiguration.java

@@ -103,6 +103,9 @@ public class DSConfiguration {
     @Value("${DS_ADMIN_BASE_PATH}")
     private String adminBasePath;
 
+    @Value("${DS_WEBFORMS_BASE_PATH}")
+    private String webFormsBasePath;
+
     @Value("${DS_MAESTRO_BASE_PATH}")
     private String maestroBasePath;
 

src/main/java/com/docusign/HttpsConnectWebhookhMacValidation.java

@@ -43,8 +43,9 @@ public static boolean HashIsValid(String secret, byte[] payload, String verify)
         return isEqual;
     }
     //ds-snippet-end:Connect1Step1
-    public static void main(String[] args) {
 
+    public static void main(String[] args)
+    {
         LOGGER.info("DocuSign HMAC Tester");
         try {
             Boolean response = HttpsConnectWebhookhMacValidation.HashIsValid("{DocuSign HMAC private key}",

src/main/java/com/docusign/common/ApiIndex.java

@@ -7,7 +7,8 @@ public enum ApiIndex {
     MAESTRO("/pages/maestro/index", "", "/mae001", "/mae"),
     MONITOR("/pages/monitor/index", "", "/m001", "/m"),
     ADMIN("/pages/admin/index", "/management", "/a001", "/a"),
-    CONNECT("/pages/connect/index", "", "/con001", "/con");
+    CONNECT("/pages/connect/index", "", "/con001", "/con"),
+    WEBFORMS("/pages/webforms/index", "/restapi", "/web001", "/web");
 
     private final String indexPath;
 

src/main/java/com/docusign/controller/eSignature/examples/EG006ControllerEnvelopeDocs.java

@@ -49,13 +49,15 @@ protected void onInitModel(WorkArguments args, ModelMap model) throws Exception
     protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException {
         EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken());
 
-        // Step 1. List the envelope's documents
+        // List the envelope's documents
+        //ds-snippet-start:eSign6Step3
         EnvelopeDocumentsResult envelopeDocumentsResult = EnvelopeDocsService.envelopeDocs(
                 envelopesApi,
                 session.getAccountId(),
                 session.getEnvelopeId());
-
-        // Step 2. Process results
+        //ds-snippet-end:eSign6Step3
+        
+        // Process results
         // Save the envelopeId and its list of documents in the session so
         // they can be used in example 7 (download a document)
         List<EnvelopeDocumentInfo> envelopeDocItems = new ArrayList<>();

src/main/java/com/docusign/controller/eSignature/services/DocumentGenerationService.java

@@ -32,17 +32,7 @@ public final class DocumentGenerationService {
 
     public static final String DEFAULT_ID = "1";
 
-    public static DateSigned createDateSigned() {
-        DateSigned dateSigned = new DateSigned();
-
-        dateSigned.setAnchorString("Date");
-        dateSigned.setAnchorUnits(ANCHOR_UNITS);
-        dateSigned.setAnchorYOffset("-22");
-
-        return dateSigned;
-    }
-
-    // Step 3b start
+    //ds-snippet-start:eSign42Step3
     private static EnvelopeDefinition addDocumentTemplate(String offerDocDocx) throws IOException {
         String documentName = "OfferLetterDemo.docx";
         Document document = EnvelopeHelpers.createDocumentFromFile(offerDocDocx, documentName, DEFAULT_ID);
@@ -54,6 +44,7 @@ private static EnvelopeDefinition addDocumentTemplate(String offerDocDocx) throw
 
         return envelopeDefinition;
     }
+    //ds-snippet-end:eSign42Step3
 
     public String generateDocument(
             String accountId,
@@ -67,27 +58,27 @@ public String generateDocument(
             EnvelopesApi envelopesApi,
             TemplatesApi templatesApi
     ) throws ApiException, IOException {
-        // Step 2a start
+        //ds-snippet-start:eSign42Step2
         TemplateSummary template = templatesApi.createTemplate(accountId, makeTemplate());
         String templateId = template.getTemplateId();
-        // Step 2a end
+        //ds-snippet-end:eSign42Step2
 
-        // Step 3a start
+        //ds-snippet-start:eSign42Step3
         templatesApi.updateDocument(accountId, templateId, DEFAULT_ID, addDocumentTemplate(offerDocDocx));
-        // Step 3a end
+        //ds-snippet-end:eSign42Step3
 
-        // Step 4a start
+        //ds-snippet-start:eSign42Step4
         templatesApi.createTabs(accountId, templateId, DEFAULT_ID, prepareTabs());
-        // Step 4a end
+        //ds-snippet-end:eSign42Step4
 
-        // Step 5a start
+        //ds-snippet-start:eSign42Step5
         EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(
                 accountId,
                 makeEnvelope(candidateEmail, candidateName, template.getTemplateId()));
         String envelopeId = envelopeSummary.getEnvelopeId();
-        // Step 5a end
+        //ds-snippet-end:eSign42Step5
 
-        // Step 6 start
+        //ds-snippet-start:eSign42Step6
         DocGenFormFieldResponse formFieldResponse = envelopesApi.getEnvelopeDocGenFormFields(accountId, envelopeId);
         String documentId = "";
         if (!formFieldResponse.getDocGenFormFields().isEmpty()) {
@@ -96,8 +87,9 @@ public String generateDocument(
                 documentId = docGenFormFields.getDocumentId();
             }
         }
-        // Step 6 end
-        // Step 7a start
+        //ds-snippet-end:eSign42Step6
+
+        //ds-snippet-start:eSign42Step7
         DocGenFormFieldRequest formFields = getFormFields(
                 documentId,
                 candidateName,
@@ -107,18 +99,18 @@ public String generateDocument(
                 startDate);
 
         envelopesApi.updateEnvelopeDocGenFormFields(accountId, envelopeId, formFields);
-        // Step 7a end
+        //ds-snippet-end:eSign42Step7
 
-        // Step 8 start
+        //ds-snippet-start:eSign42Step8
         Envelope envelope = new Envelope();
         envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT);
 
         EnvelopeUpdateSummary envelopeUpdateSummary = envelopesApi.update(accountId, envelopeId, envelope);
-        // Step 8 end
+        //ds-snippet-end:eSign42Step8
         return envelopeUpdateSummary.getEnvelopeId();
     }
 
-    // Step 4b start
+    //ds-snippet-start:eSign42Step4
     private TemplateTabs prepareTabs() {
         SignHere signHere = createSignHere();
         DateSigned dateSigned = createDateSigned();
@@ -129,7 +121,6 @@ private TemplateTabs prepareTabs() {
 
         return templateTabs;
     }
-    // Step 4b end
 
     private SignHere createSignHere() {
         SignHere signHere = new SignHere();
@@ -141,9 +132,19 @@ private SignHere createSignHere() {
 
         return signHere;
     }
-    // Step 7b end
 
-    // Step 7b start
+    private DateSigned createDateSigned() {
+      DateSigned dateSigned = new DateSigned();
+
+      dateSigned.setAnchorString("Date");
+      dateSigned.setAnchorUnits(ANCHOR_UNITS);
+      dateSigned.setAnchorYOffset("-22");
+
+      return dateSigned;
+    }
+    //ds-snippet-end:eSign42Step4
+
+    //ds-snippet-start:eSign42Step7
     private DocGenFormFieldRequest getFormFields(
             String documentId,
             String candidateName,
@@ -185,9 +186,9 @@ private DocGenFormFieldRequest getFormFields(
 
         return docGenFormFieldRequest;
     }
-    // Step 5b end
+    //ds-snippet-end:eSign42Step7
 
-    // Step 5b start
+    //ds-snippet-start:eSign42Step5
     private EnvelopeDefinition makeEnvelope(String candidateEmail, String candidateName, String templateId) {
         TemplateRole signerRole = new TemplateRole();
         signerRole.setName(candidateName);
@@ -201,9 +202,9 @@ private EnvelopeDefinition makeEnvelope(String candidateEmail, String candidateN
 
         return envelopeDefinition;
     }
-    // Step 2b end
+    //ds-snippet-end:eSign42Step5
 
-    // Step 2b start
+    //ds-snippet-start:eSign42Step2
     private EnvelopeTemplate makeTemplate() {
         Signer signer = new Signer();
         signer.setRoleName(EnvelopeHelpers.SIGNER_ROLE_NAME);
@@ -222,5 +223,5 @@ private EnvelopeTemplate makeTemplate() {
 
         return template;
     }
-    // Step 3b stop
+    //ds-snippet-end:eSign42Step2
 }

src/main/java/com/docusign/controller/eSignature/services/ListEnvelopesServices.java

@@ -13,7 +13,7 @@ public final class ListEnvelopesServices {
     public static EnvelopesInformation listEnvelopes(EnvelopesApi envelopesApi, String accountId) throws ApiException {
         EnvelopesApi.ListStatusChangesOptions options = envelopesApi.new ListStatusChangesOptions();
         LocalDate date = LocalDate.now().minusDays(FROM_DATE_OFFSET_DAYS);
-        options.setFromDate(DateUtils.DATE_WITH_SLASH.format(date));
+        options.setFromDate(DateUtils.DATE_WITH_LINES.format(date));
         return envelopesApi.listStatusChanges(accountId, options);
     }
 }

src/main/java/com/docusign/controller/eSignature/services/SetDocumentVisibilityService.java

@@ -4,9 +4,14 @@
 import com.docusign.esign.model.*;
 
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.Collections;
 
+import org.apache.commons.io.FilenameUtils;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.util.StreamUtils;
+
 public final class SetDocumentVisibilityService {
     //ds-snippet-start:eSign40Step3  
     public static EnvelopeDefinition makeEnvelope(
@@ -32,10 +37,15 @@ public static EnvelopeDefinition makeEnvelope(
         recipients.setCarbonCopies(Collections.singletonList(carbonCopy));
 
         EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition();
+        envelopeDefinition.setEnforceSignerVisibility("true");
         envelopeDefinition.setEmailSubject("Please sign this document set");
         envelopeDefinition.setRecipients(recipients);
 
         envelopeDefinition.setDocuments(Arrays.asList(prepareDocumentsForSending(
+                signerEmail,
+                signerName,
+                ccEmail,
+                ccName,
                 documentFileNamePDF,
                 documentFileNameDOCX,
                 documentFileNameHTML)));
@@ -72,12 +82,26 @@ private static Signer[] prepareSigners(
     }
 
     private static Document[] prepareDocumentsForSending(
+            String signerEmail,
+            String signerName,
+            String ccEmail,
+            String ccName,
             String documentFileNamePDF,
             String documentFileNameDOCX,
             String documentFileNameHTML) throws IOException {
-        Document documentHTML = EnvelopeHelpers.createDocumentFromFile(
-                documentFileNameHTML,
+        ClassPathResource resource = new ClassPathResource(documentFileNameHTML);
+        String documentHTMLContentsString = StreamUtils.copyToString(resource.getInputStream(), StandardCharsets.UTF_8);
+        documentHTMLContentsString = documentHTMLContentsString.replace("{USER_EMAIL}", signerEmail);
+        documentHTMLContentsString = documentHTMLContentsString.replace("{USER_FULLNAME}", signerName);
+        documentHTMLContentsString = documentHTMLContentsString.replace("{CC_EMAIL}", ccEmail);
+        documentHTMLContentsString = documentHTMLContentsString.replace("{CC_NAME}", ccName);
+        byte[] documentHTMLContentsBytes = documentHTMLContentsString.getBytes(StandardCharsets.UTF_8);
+        String extension = FilenameUtils.getExtension(documentFileNameHTML);
+        
+        Document documentHTML = EnvelopeHelpers.createDocument(
+                documentHTMLContentsBytes,
                 "Order acknowledgement",
+                extension,
                 "1");
 
         Document documentDOCX = EnvelopeHelpers.createDocumentFromFile(