support custom folders

Author: RomanBachaloSigmaSoftware

app/controllers/e_sign/eeg045_delete_restore_envelope_controller.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+require_relative '../../services/utils'
+
 class ESign::Eeg045DeleteRestoreEnvelopeController < EgController
   before_action -> { check_auth('eSignature') }
   before_action -> { @example = Utils::ManifestUtils.new.get_example(@manifest, 45, 'eSignature') }
 
   DELETE_FOLDER_ID = 'recyclebin'
-  RESTORE_FOLDER_ID = 'sentitems'
 
   def delete_envelope
     args = {
@@ -16,36 +17,48 @@ def delete_envelope
       folder_id: DELETE_FOLDER_ID
     }
 
-    delete_restore_envelope_service = ESign::Eg045DeleteRestoreEnvelopeService.new(args)
+    delete_restore_envelope_service = ESign::Eg045DeleteRestoreEnvelopeService.new
 
-    delete_restore_envelope_service.move_envelope
+    delete_restore_envelope_service.move_envelope args
 
     session[:envelope_id] = args[:envelope_id]
     additional_page_data = @example['AdditionalPage'].find { |p| p['Name'] == 'envelope_is_deleted' }
     @title = @example['ExampleName']
-    @message = additional_page_data['ResultsPageText']
+    @message = format_string(additional_page_data['ResultsPageText'], args[:envelope_id])
     @redirect_url = "/#{session[:eg]}restore"
 
     render 'ds_common/example_done'
   end
 
   def restore_envelope
+    folder_name = param_gsub(params['folder_name'])
     args = {
       account_id: session['ds_account_id'],
       base_path: session['ds_base_path'],
       access_token: session['ds_access_token'],
       envelope_id: param_gsub(session[:envelope_id]),
-      folder_id: RESTORE_FOLDER_ID,
       from_folder_id: DELETE_FOLDER_ID
     }
 
-    delete_restore_envelope_service = ESign::Eg045DeleteRestoreEnvelopeService.new(args)
+    delete_restore_envelope_service = ESign::Eg045DeleteRestoreEnvelopeService.new
+
+    folders = delete_restore_envelope_service.get_folders args
+    args[:folder_id] = Utils::DocuSignUtils.new.get_folder_id_by_name(folders.folders, folder_name)
+
+    if args[:folder_id].nil? || args[:folder_id].empty?
+      additional_page_data = @example['AdditionalPage'].find { |p| p['Name'] == 'folder_does_not_exist' }
+      @title = @example['ExampleName']
+      @message = format_string(additional_page_data['ResultsPageText'], folder_name)
+      @redirect_url = "/#{session[:eg]}restore"
+
+      return render 'ds_common/example_done'
+    end
 
-    delete_restore_envelope_service.move_envelope
+    delete_restore_envelope_service.move_envelope args
 
     session[:envelope_id] = args[:envelope_id]
     @title = @example['ExampleName']
-    @message = @example['ResultsPageText']
+    @message = format_string(@example['ResultsPageText'], session[:envelope_id], args[:folder_id], folder_name)
     render 'ds_common/example_done'
   end
 

app/services/e_sign/eg045_delete_restore_envelope_service.rb

@@ -1,15 +1,9 @@
 # frozen_string_literal: true
 
 class ESign::Eg045DeleteRestoreEnvelopeService
-  attr_reader :args
-
   include ApiCreator
 
-  def initialize(args)
-    @args = args
-  end
-
-  def move_envelope
+  def move_envelope(args)
     #ds-snippet-start:eSign45Step2
     folders_api = create_folders_api(args)
     #ds-snippet-end:eSign45Step2
@@ -24,4 +18,12 @@ def move_envelope
     folders_api.move_envelopes(args[:account_id], args[:folder_id], folders_request)
     #ds-snippet-end:eSign45Step4
   end
+
+  def get_folders(args)
+    folders_api = create_folders_api(args)
+
+    #ds-snippet-start:eSign45Step5
+    folders_api.list(args[:account_id])
+    #ds-snippet-end:eSign45Step5
+  end
 end

app/services/utils.rb

@@ -1,56 +1,71 @@
-module Utils
-  class ManifestUtils
-    def get_manifest(manifest_url)
-      uri = URI(manifest_url)
-      res = Net::HTTP.get_response(uri)
-      JSON.parse(res.body)
-    end
-
-    def get_example(manifest, number, api_name = 'eSignature')
-      manifest['APIs'].each do |api|
-        next unless api_name == api['Name']
-
-        api['Groups'].each do |group|
-          group['Examples'].each do |example|
-            return example if example['ExampleNumber'] == number
-          end
-        end
-      end
-    end
-  end
-
-  class DocuSignUtils
-    def get_user_id(args)
-      configuration = DocuSign_eSign::Configuration.new
-      configuration.host = args[:base_path]
-      api_client = DocuSign_eSign::ApiClient.new configuration
-      api_client.set_base_path(args[:base_path])
-      api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
-      user_info = api_client.get_user_info(args[:access_token])
-      user_info.sub
-    end
-  end
-
-  class FileUtils
-    def replace_template_id(file_path, template_id)
-      content = File.read(file_path)
-
-      content.gsub!('template-id', template_id)
-
-      File.write(file_path, content)
-    end
-  end
-
-  class URLUtils
-    def get_parameter_value_from_url(url, param_name)
-      parsed_url = URI.parse(url)
-      query_params = URI.decode_www_form(parsed_url.query || '')
-
-      # Access the parameter value (returns a list)
-      param_value_list = query_params.assoc(param_name)
-
-      # If the parameter exists, return the first value; otherwise, return nil
-      param_value_list ? param_value_list[1] : nil
-    end
-  end
-end
+module Utils
+  class ManifestUtils
+    def get_manifest(manifest_url)
+      uri = URI(manifest_url)
+      res = Net::HTTP.get_response(uri)
+      JSON.parse(res.body)
+    end
+
+    def get_example(manifest, number, api_name = 'eSignature')
+      manifest['APIs'].each do |api|
+        next unless api_name == api['Name']
+
+        api['Groups'].each do |group|
+          group['Examples'].each do |example|
+            return example if example['ExampleNumber'] == number
+          end
+        end
+      end
+    end
+  end
+
+  class DocuSignUtils
+    def get_user_id(args)
+      configuration = DocuSign_eSign::Configuration.new
+      configuration.host = args[:base_path]
+      api_client = DocuSign_eSign::ApiClient.new configuration
+      api_client.set_base_path(args[:base_path])
+      api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
+      user_info = api_client.get_user_info(args[:access_token])
+      user_info.sub
+    end
+
+    def get_folder_id_by_name(folders, folder_name)
+      folders.each do |folder|
+        if folder.name.downcase == folder_name.downcase
+          return folder.folder_id
+        end
+
+        if folder.folders&.any?
+          folder_id = get_folder_id_by_name(folder.folders, folder_name)
+          return folder_id if folder_id
+        end
+      end
+
+      nil
+    end
+  end
+
+  class FileUtils
+    def replace_template_id(file_path, template_id)
+      content = File.read(file_path)
+
+      content.gsub!('template-id', template_id)
+
+      File.write(file_path, content)
+    end
+  end
+
+  class URLUtils
+    def get_parameter_value_from_url(url, param_name)
+      parsed_url = URI.parse(url)
+      query_params = URI.decode_www_form(parsed_url.query || '')
+
+      # Access the parameter value (returns a list)
+      param_value_list = query_params.assoc(param_name)
+
+      # If the parameter exists, return the first value; otherwise, return nil
+      param_value_list ? param_value_list[1] : nil
+    end
+  end
+end

app/views/e_sign/eeg045_delete_restore_envelope/restore.html.erb

@@ -3,12 +3,19 @@
 <%= sanitize format_string(@manifest["SupportingTexts"]["HelpingTexts"]["EnvelopeWillBeRestored"], @envelope_id) %>
 
 <% form_index = 0 %>
+<% folder_name_index = 1 %>
 
 <form class="eg" action="" method="post" data-busy="form">
   <% if @example["Forms"][form_index]["FormName"] %>
     <%= sanitize @example["Forms"][form_index]["FormName"] %>
   <% end %>
 
+  <div class="form-group">
+    <label for="folder_name"><%= @example["Forms"][form_index]["Inputs"][folder_name_index]["InputName"] %></label>
+    <input type="text" class="form-control" id="folder_name" name="folder_name" required
+           placeholder="<%= @example["Forms"][form_index]["Inputs"][folder_name_index]["InputPlaceholder"] %>">
+  </div>
+
   <%= render('partials/submit_button') %>
 </form>