Add Connected fields code example (#186)

* add code example

* code style fixes

Author: RomanBachaloSigmaSoftware

Gemfile

@@ -68,12 +68,12 @@ group :test do
   gem 'test-unit'
 end
 
-gem 'docusign_admin', '~> 2.0.0.rc2'
+gem 'docusign_admin', '~> 2.0.0'
 gem 'docusign_click', '~> 1.4.0'
 gem 'docusign_esign', '~> 5.0.0'
 gem 'docusign_monitor', '~> 1.2.0'
 gem 'docusign_rooms', '~> 1.3.0'
-gem 'docusign_webforms', '~> 1.0.0'
+gem 'docusign_webforms', '~> 2.0.0'
 gem 'omniauth-oauth2', '~> 1.8.0'
 gem 'omniauth-rails_csrf_protection'
 

Gemfile.lock

@@ -134,7 +134,7 @@ GEM
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
-    docusign_webforms (1.0.0)
+    docusign_webforms (2.0.0)
       addressable (~> 2.7, >= 2.7.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
@@ -392,12 +392,12 @@ DEPENDENCIES
   capybara (~> 3.40.0)
   chromedriver-helper (~> 2.1.1)
   coffee-rails (~> 5.0.0)
-  docusign_admin (~> 2.0.0.rc2)
+  docusign_admin (~> 2.0.0)
   docusign_click (~> 1.4.0)
   docusign_esign (~> 5.0.0)
   docusign_monitor (~> 1.2.0)
   docusign_rooms (~> 1.3.0)
-  docusign_webforms (~> 1.0.0)
+  docusign_webforms (~> 2.0.0)
   jbuilder (~> 2.13.0)
   listen (~> 3.9.0)
   matrix (~> 0.4.2)

app/assets/javascripts/search.js

@@ -7,7 +7,8 @@ const DS_SEARCH = (function () {
     ADMIN: "admin",
     CONNECT: "connect",
     WEBFORMS: "webforms",
-    NOTARY: "notary"
+    NOTARY: "notary",
+    CONNECTED_FIELDS: "connectedfields"
   }
 
   const processJSONData = function () {
@@ -148,6 +149,8 @@ const DS_SEARCH = (function () {
         return "weg";
       case API_TYPES.NOTARY:
         return "neg";
+      case API_TYPES.CONNECTED_FIELDS:
+        return "feg";
     }
   }
 

app/controllers/connected_fields/feg001_set_connected_fields_controller.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative '../../services/utils'
+
+class ConnectedFields::Feg001SetConnectedFieldsController < EgController
+  before_action -> { check_auth('ConnectedFields') }
+  before_action -> { @example = Utils::ManifestUtils.new.get_example(@manifest, 1, 'ConnectedFields') }
+
+  def get
+    super
+    args = {
+      account_id: session['ds_account_id'],
+      access_token: session['ds_access_token'],
+      extensions_base_path: 'https://api-d.docusign.com'
+    }
+
+    example_service = ConnectedFields::Eg001SetConnectedFieldsService.new(args)
+    @apps = example_service.get_tab_groups
+
+    return unless @apps.nil? || @apps.empty?
+
+    additional_page_data = example['AdditionalPage'].find { |p| p['Name'] == 'no_verification_app' }
+
+    @title = @example['ExampleName']
+    @message = additional_page_data['ResultsPageText']
+    render 'ds_common/example_done'
+  end
+
+  def create
+    envelope_args = {
+      signer_email: param_gsub(params['signerEmail']),
+      signer_name: param_gsub(params['signerName']),
+      doc_pdf: File.join('data', Rails.application.config.doc_pdf)
+    }
+    args = {
+      account_id: session['ds_account_id'],
+      base_path: session['ds_base_path'],
+      extensions_base_path: 'https://api-d.docusign.com',
+      access_token: session['ds_access_token'],
+      selected_app_id: param_gsub(params['appId']),
+      envelope_args: envelope_args
+    }
+
+    example_service = ConnectedFields::Eg001SetConnectedFieldsService.new(args)
+    apps = example_service.get_tab_groups
+    selected_app = apps.find { |app| app['appId'] == args[:selected_app_id] }
+
+    results = example_service.send_envelope selected_app
+    session[:envelope_id] = results['envelope_id']
+    @title = @example['ExampleName']
+    @message = format_string(@example['ResultsPageText'], results['envelope_id'])
+    render 'ds_common/example_done'
+  rescue DocuSign_eSign::ApiError => e
+    handle_error(e)
+  end
+end

app/services/connected_fields/eg001_set_connected_fields_service.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+class ConnectedFields::Eg001SetConnectedFieldsService
+  attr_reader :args
+
+  include ApiCreator
+
+  def initialize(args)
+    @args = args
+  end
+
+  def get_tab_groups
+    #ds-snippet-start:ConnectedFields1Step2
+    headers = {
+      'Authorization' => "Bearer #{args[:access_token]}",
+      'Accept' => 'application/json',
+      'Content-Type' => 'application/json'
+    }
+    #ds-snippet-end:ConnectedFields1Step2
+
+    #ds-snippet-start:ConnectedFields1Step3
+    url = URI("#{args[:extensions_base_path]}/v1/accounts/#{args[:account_id]}/connected-fields/tab-groups")
+    response = Net::HTTP.get_response(url, headers)
+    response_data = JSON.parse(response.body)
+
+    filtered_apps = response_data.select do |app|
+      app['tabs']&.any? do |tab|
+        (tab['extensionData']&.dig('actionContract')&.include? 'Verify') ||
+          (tab['tabLabel']&.include? 'connecteddata')
+      end
+    end
+
+    # return unique apps
+    filtered_apps.uniq { |app| app['appId'] }
+    #ds-snippet-end:ConnectedFields1Step3
+  end
+
+  #ds-snippet-start:ConnectedFields1Step4
+  def extract_verification_data(selected_app_id, tab)
+    extension_data = tab['extensionData']
+
+    {
+      app_id: selected_app_id,
+      extension_group_id: extension_data['extensionGroupId'],
+      publisher_name: extension_data['publisherName'],
+      application_name: extension_data['applicationName'],
+      action_name: extension_data['actionName'],
+      action_input_key: extension_data['actionInputKey'],
+      action_contract: extension_data['actionContract'],
+      extension_name: extension_data['extensionName'],
+      extension_contract: extension_data['extensionContract'],
+      required_for_extension: extension_data['requiredForExtension'],
+      tab_label: tab['tabLabel'],
+      connection_key: extension_data['connectionInstances']&.dig(0, 'connectionKey') || '',
+      connection_value: extension_data['connectionInstances']&.dig(0, 'connectionValue') || ''
+    }
+  end
+  #ds-snippet-end:ConnectedFields1Step4
+
+  def send_envelope(app)
+    # Create the envelope definition
+    #ds-snippet-start:ConnectedFields1Step6
+    envelope = make_envelope args[:envelope_args], app
+
+    # Call Docusign to create the envelope
+    envelope_api = create_envelope_api(args)
+
+    results = envelope_api.create_envelope args[:account_id], envelope
+
+    { 'envelope_id' => results.envelope_id }
+    #ds-snippet-end:ConnectedFields1Step6
+  end
+
+  private
+
+  #ds-snippet-start:ConnectedFields1Step5
+  def make_envelope(envelope_args, app)
+    doc = DocuSign_eSign::Document.new
+    doc.document_base64 = Base64.encode64(File.binread(envelope_args[:doc_pdf]))
+    doc.name = 'Lorem Ipsum'
+    doc.file_extension = 'pdf'
+    doc.document_id = '1'
+
+    # The order in the docs array determines the order in the envelope
+    # Create a signer recipient to sign the document, identified by name and email
+    # We're setting the parameters via the object creation
+    signer = DocuSign_eSign::Signer.new
+    signer.email = envelope_args[:signer_email]
+    signer.name = envelope_args[:signer_name]
+    signer.recipient_id = 1
+
+    # The Docusign platform searches throughout your envelope's documents for matching
+    # anchor strings. So the sign_here_2 tab will be used in both document 2 and 3
+    # since they use the same anchor string for their "signer 1" tabs.
+    sign_here = DocuSign_eSign::SignHere.new
+    sign_here.anchor_string = '/sn1/'
+    sign_here.anchor_units = 'pixels'
+    sign_here.anchor_x_offset = '20'
+    sign_here.anchor_y_offset = '10'
+
+    text_tabs = []
+    app['tabs'].each do |tab|
+      next if tab['tabLabel'].include?('SuggestionInput')
+
+      verification_data = extract_verification_data(app['appId'], tab)
+      text_tabs.push(text_tab(verification_data, text_tabs.length))
+    end
+
+    tabs = DocuSign_eSign::Tabs.new
+    tabs.sign_here_tabs = [sign_here]
+    tabs.text_tabs = text_tabs
+    signer.tabs = tabs
+
+    recipients = DocuSign_eSign::Recipients.new
+    recipients.signers = [signer]
+
+    envelope_definition = DocuSign_eSign::EnvelopeDefinition.new
+    envelope_definition.email_subject = 'Please sign this document'
+    envelope_definition.documents = [doc]
+    envelope_definition.recipients = recipients
+    envelope_definition.status = 'sent'
+    envelope_definition
+  end
+
+  def extension_data(verification_data)
+    {
+      extensionGroupId: verification_data[:extension_group_id],
+      publisherName: verification_data[:publisher_name],
+      applicationId: verification_data[:app_id],
+      applicationName: verification_data[:application_name],
+      actionName: verification_data[:action_name],
+      actionContract: verification_data[:action_contract],
+      extensionName: verification_data[:extension_name],
+      extensionContract: verification_data[:extension_contract],
+      requiredForExtension: verification_data[:required_for_extension],
+      actionInputKey: verification_data[:action_input_key],
+      extensionPolicy: 'MustVerifyToSign',
+      connectionInstances: [
+        {
+          connectionKey: verification_data[:connection_key],
+          connectionValue: verification_data[:connection_value]
+        }
+      ]
+    }
+  end
+
+  def text_tab(verification_data, text_tabs_count)
+    {
+      requireInitialOnSharedChange: false,
+      requireAll: false,
+      name: verification_data[:application_name],
+      required: true,
+      locked: false,
+      disableAutoSize: false,
+      maxLength: 4000,
+      tabLabel: verification_data[:tab_label],
+      font: 'lucidaconsole',
+      fontColor: 'black',
+      fontSize: 'size9',
+      documentId: '1',
+      recipientId: '1',
+      pageNumber: '1',
+      xPosition: (70 + 100 * (text_tabs_count / 10)).to_s,
+      yPosition: (560 + 20 * (text_tabs_count % 10)).to_s,
+      width: '84',
+      height: '22',
+      templateRequired: false,
+      tabType: 'text',
+      tooltip: verification_data[:action_input_key],
+      extensionData: extension_data(verification_data)
+    }
+  end
+  #ds-snippet-end:ConnectedFields1Step5
+end

app/services/jwt_auth/jwt_creator.rb

@@ -19,6 +19,7 @@ def self.consent_url(state, api)
       scope = 'signature impersonation organization_read group_read permission_read user_read user_write account_read domain_read identity_provider_read user_data_redact asset_group_account_read asset_group_account_clone_write asset_group_account_clone_read organization_sub_account_write organization_sub_account_read' if api == 'Admin'
       scope = 'signature webforms_read webforms_instance_read webforms_instance_write' if api == 'WebForms'
       scope = 'signature organization_read notary_read notary_write' if api == 'Notary'
+      scope = 'signature adm_store_unified_repo_read' if api == 'ConnectedFields'
 
       base_uri = "#{Rails.configuration.authorization_server}/oauth/auth"
       response_type = 'code'
@@ -55,6 +56,10 @@ def initialize(session)
         scope = 'signature organization_read notary_read notary_write'
         @client_module = DocuSign_eSign
       end
+      if session[:api] == 'ConnectedFields'
+        scope = 'signature adm_store_unified_repo_read'
+        @client_module = DocuSign_eSign
+      end
 
       @scope = scope
       @api_client = create_initial_api_client(host: Rails.configuration.aud, client_module: @client_module, debugging: false)

app/views/connected_fields/feg001_set_connected_fields/get.html.erb

@@ -0,0 +1,36 @@
+<%= render('partials/example_info') %>
+
+<% form_index = 0 %>
+<% signer_email_index = 0 %>
+<% signer_name_index = 1 %>
+<% app_index = 2 %>
+
+  <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="signerEmail"><%= @example["Forms"][form_index]["Inputs"][signer_email_index]["InputName"] %></label>
+      <input type="email" class="form-control" id="signerEmail" name="signerEmail"
+             aria-describedby="emailHelp"
+             placeholder="<%= @example["Forms"][form_index]["Inputs"][signer_email_index]["InputPlaceholder"] %>" required
+             value="<%= @config.signer_email %>">
+      <%= render('partials/email_will_not_be_shared') %>
+    </div>
+    <div class="form-group">
+      <label for="signerName"><%= @example["Forms"][form_index]["Inputs"][signer_name_index]["InputName"] %></label>
+      <input type="text" class="form-control" id="signerName"
+             placeholder="<%= @example["Forms"][form_index]["Inputs"][signer_name_index]["InputPlaceholder"] %>" name="signerName"
+             value="<%= @config.signer_name %>" required>
+    </div>
+    <div class="form-group">
+      <label for="appId"><%= @example["Forms"][form_index]["Inputs"][app_index]["InputName"] %></label>
+      <select id="appId" name="appId" class="form-control" required>
+        <% @apps.each do |app| %>
+          <option value="<%= app['appId'] %>" selected><%= app['tabs'][0]['extensionData']['applicationName'] %></option>
+        <% end %>
+      </select>
+    </div>
+    <%= render('partials/submit_button') %>
+  </form>

app/views/ds_common/index.html.erb

@@ -57,6 +57,8 @@
                                 "w"
                               elsif api["Name"] == "Notary"
                                 "n"
+                              elsif api["Name"] == "ConnectedFields"
+                                "f"
                               else
                                 "e"
                               end %>

config/initializers/omniauth.rb

@@ -56,6 +56,8 @@
       strategy.options[:authorize_params].scope = 'signature webforms_read webforms_instance_read webforms_instance_write'
     when 'Notary'
       strategy.options[:authorize_params].scope = 'signature organization_read notary_read notary_write'
+    when 'ConnectedFields'
+      strategy.options[:authorize_params].scope = 'signature adm_store_unified_repo_read'
     end
   }
 end

config/routes.rb

@@ -250,6 +250,11 @@
     post 'neg004' => 'neg004_send_with_third_party_notary#create'
   end
 
+  scope module: 'connected_fields' do
+    get 'feg001' => 'feg001_set_connected_fields#get'
+    post 'feg001' => 'feg001_set_connected_fields#create'
+  end
+
   root 'ds_common#index'
 
   # Login starts with POST'ing to: /auth/docusign