Add step comments for document visibility and IPS

Author: karissarjacobsen

app/services/e_sign/eg039_signing_in_person_service.rb

@@ -17,23 +17,26 @@ def worker
     host_name = args[:host_name]
     signer_name = args[:signer_name]
 
-    # Step 1. Create the envelope definition
     envelope = make_envelope(pdf_filename, host_email, host_name, signer_name)
 
-    # Step 2. Call DocuSign to create the envelope
+     # Step 3 start
     envelope_api = create_envelope_api(args)
 
     results = envelope_api.create_envelope args[:account_id], envelope
+    # Step 3 end
+
     envelope_id = results.envelope_id
 
-    # Step 3. Create the recipient view for the embedded signing
+
+    # Step 5 start
     view_request = make_recipient_view_request(ds_return_url, ds_ping_url, host_email, host_name
     )
 
     # Call the CreateRecipientView API
     results = envelope_api.create_recipient_view args[:account_id], envelope_id, view_request
+    # Step 5 end
 
-    # Step 4. Redirect the user to the embedded signing
+    # Redirect the user to the embedded signing
     # Don't use an iframe!
     # State can be stored/recovered using the framework's session or a
     # query parameter on the returnUrl (see the makeRecipientViewRequest method)
@@ -43,6 +46,7 @@ def worker
 
   private
 
+  # Step 4 start
   def make_recipient_view_request(ds_return_url, ds_ping_url, host_email, host_name)
     view_request = DocuSign_eSign::RecipientViewRequest.new
     # Set the URL where you want the recipient to go once they are done signing
@@ -74,7 +78,9 @@ def make_recipient_view_request(ds_return_url, ds_ping_url, host_email, host_nam
 
     view_request
   end
+  # Step 4 end
 
+  # Step 2 start
   def make_envelope(pdf_filename, host_email, host_name, signer_name)
     envelope_definition = DocuSign_eSign::EnvelopeDefinition.new
     envelope_definition.email_subject = 'Please sign this document sent from Ruby SDK'
@@ -118,5 +124,5 @@ def make_envelope(pdf_filename, host_email, host_name, signer_name)
     envelope_definition.status = 'sent'
     envelope_definition
   end
-  # ***DS.snippet.0.end
+  # Step 2 end
 end

app/services/e_sign/eg040_set_document_visibility_service.rb

@@ -9,19 +9,24 @@ def initialize(args)
   end
 
   def worker
-    # 1. Create the envelope request object
+    # Step 3-1 start
     envelope_definition = make_envelope args[:envelope_args]
-    # 2. Call Envelopes::create API method
+    # Step 3-1 end
+
     # Exceptions will be caught by the calling function
+    # Step 4 start
     envelope_api = create_envelope_api(args)
 
     results = envelope_api.create_envelope args[:account_id], envelope_definition
     envelope_id = results.envelope_id
+    # Step 4 end
+
     { 'envelope_id' => envelope_id }
   end
 
   private
 
+  # Step 3-2 start
   def make_envelope(envelope_args)
     # document 1 (HTML) has tag **signature_1**
     # document 2 (DOCX) has tag /sn1/
@@ -141,6 +146,7 @@ def make_envelope(envelope_args)
     envelope_definition.status = envelope_args[:status]
     envelope_definition
   end
+  # Step 3-2 end
 
   def create_document1(args)
     "