add notary example

Author: RomanBachaloSigmaSoftware

app/assets/javascripts/search.js

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

app/controllers/notary/neg004_send_with_third_party_notary_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../../services/utils'
+
+class Notary::Neg004SendWithThirdPartyNotaryController < EgController
+  before_action -> { check_auth('Notary') }
+  before_action -> { @example = Utils::ManifestUtils.new.get_example(@manifest, 4, 'Notary') }
+
+  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'],
+      access_token: session['ds_access_token'],
+      envelope_args: envelope_args
+    }
+    results = Notary::Eg004SendWithThirdPartyNotaryService.new(args).worker
+    @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/jwt_auth/jwt_creator.rb

@@ -18,6 +18,7 @@ def self.consent_url(state, api)
       scope = 'signature impersonation click.manage click.send' if api == 'Click'
       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'
 
       base_uri = "#{Rails.configuration.authorization_server}/oauth/auth"
       response_type = 'code'
@@ -50,6 +51,10 @@ def initialize(session)
         scope = 'signature webforms_read webforms_instance_read webforms_instance_write'
         @client_module = DocuSign_WebForms
       end
+      if session[:api] == 'Notary'
+        scope = 'signature organization_read notary_read notary_write'
+        @client_module = DocuSign_eSign
+      end
 
       @scope = scope
       @api_client = create_initial_api_client(host: Rails.configuration.aud, client_module: @client_module, debugging: false)

app/services/notary/eg004_send_with_third_party_notary_service.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+class Notary::Eg004SendWithThirdPartyNotaryService
+  attr_reader :args
+
+  include ApiCreator
+
+  def initialize(args)
+    @args = args
+  end
+
+  #ds-snippet-start:Notary4Step3
+  def worker
+    # Create the envelope request object
+    envelope_definition = make_envelope args[:envelope_args]
+    # Call Envelopes::create API method
+    # Exceptions will be caught by the calling function
+    envelope_api = create_envelope_api(args)
+
+    results = envelope_api.create_envelope args[:account_id], envelope_definition
+    envelope_id = results.envelope_id
+    { 'envelope_id' => envelope_id }
+  end
+  #ds-snippet-end:Notary4Step3
+
+  private
+
+  #ds-snippet-start:Notary4Step2
+  def make_envelope(envelope_args)
+    # document 1 (HTML) has tag **signature_1**
+    # document 2 (DOCX) has tag /sn1/
+    # document 3 (PDF) has tag /sn1/
+    #
+    # The envelope has two recipients:
+    # recipient 1 - signer
+    # recipient 2 - cc
+    # The envelope will be sent first to the signer.
+    # After it is signed, a copy is sent to the cc person
+
+    # Create the envelope definition
+    envelope_definition = DocuSign_eSign::EnvelopeDefinition.new
+
+    envelope_definition.email_subject = 'Please sign this document set'
+
+    # Add the document
+    doc_b64 = Base64.encode64(File.binread(envelope_args[:doc_pdf]))
+
+    # Create the document model
+    document = DocuSign_eSign::Document.new(
+      # Create the Docusign document object
+      documentBase64: doc_b64,
+      name: 'Order acknowledgement', # Can be different from actual file name
+      fileExtension: 'html', # Many different document types are accepted
+      documentId: '1' # A label used to reference the doc
+    )
+
+    # The order in the docs array determines the order in the envelope
+    envelope_definition.documents = [document]
+
+    # Create the signer recipient model
+    signer = DocuSign_eSign::Signer.new
+    signer.email = envelope_args[:signer_email]
+    signer.name = envelope_args[:signer_name]
+    signer.recipient_id = '1'
+    signer.routing_order = '1'
+    ## routingOrder (lower means earlier) determines the order of deliveries
+    # to the recipients. Parallel routing order is supported by using the
+    # same integer as the order for two or more recipients
+
+    # Create signHere fields (also known as tabs) on the documents
+    # We're using anchor (autoPlace) positioning
+    #
+    # 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(
+      anchorString: '/sn1/',
+      anchorYOffset: '10',
+      anchorUnits: 'pixels',
+      anchorXOffset: '20'
+    )
+
+    # Add the tabs model (including the sign_here tabs) to the signer
+    # The Tabs object takes arrays of the different field/tab types
+    signer_tab = DocuSign_eSign::Tabs.new({
+                                            signHereTabs: [sign_here]
+                                          })
+
+    signer.tabs = signer_tab
+
+    notary_seal = DocuSign_eSign::NotarySeal.new(
+      xPosition: '300',
+      yPosition: '235',
+      documentId: '1',
+      pageNumber: '1',
+    )
+
+    notary_sign_here = DocuSign_eSign::SignHere.new(
+      xPosition: '300',
+      yPosition: '150',
+      documentId: '1',
+      pageNumber: '1',
+    )
+
+    notary_tabs = DocuSign_eSign::Tabs.new(
+      signHereTabs: [notary_sign_here],
+      notarySealTabs: [notary_seal]
+    )
+
+    notary_recipient = DocuSign_eSign::NotaryRecipient.new(
+      email: '',
+      name: 'Notary',
+      recipientId: '1',
+      routingOrder: '1',
+      tabs: notary_tabs,
+      notaryType: 'remote',
+      notarySourceType: 'thirdparty',
+      notaryThirdPartyPartner: 'onenotary',
+      recipientSignatureProviders: [
+        {
+          sealDocumentsWithTabsOnly: 'false',
+          signatureProviderName: 'ds_authority_idv',
+          signatureProviderOptions: {}
+        }
+      ]
+    )
+
+    # Add the recipients to the envelope object
+    recipients = DocuSign_eSign::Recipients.new(
+      signers: [signer],
+      notary: [notary_recipient]
+    )
+    # Request that the envelope be sent by setting status to "sent".
+    # To request that the envelope be created as a draft, set status to "created"
+    envelope_definition.recipients = recipients
+    envelope_definition.status = 'sent'
+    envelope_definition
+  end
+  #ds-snippet-end:Notary4Step2
+end

app/views/ds_common/index.html.erb

@@ -55,6 +55,8 @@
                                 "cn"
                               elsif api["Name"] == "WebForms"
                                 "w"
+                              elsif api["Name"] == "Notary"
+                                "n"
                               else
                                 "e"
                               end %>

app/views/notary/neg004_send_with_third_party_notary/get.html.erb

@@ -0,0 +1,27 @@
+<%= render('partials/example_info') %>
+
+<% form_index = 0 %>
+<% signer_email_index = 0 %>
+<% signer_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="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>
+    <%= render('partials/submit_button') %>
+  </form>

config/initializers/omniauth.rb

@@ -54,6 +54,8 @@
       strategy.options[:authorize_params].scope = 'signature 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'
     when 'WebForms'
       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'
     end
   }
 end

config/routes.rb

@@ -245,6 +245,11 @@
     post 'weg001webForm' => 'weg001_create_instance#create_web_form_instance'
   end
 
+  scope module: 'notary' do
+    get 'neg004' => 'neg004_send_with_third_party_notary#get'
+    post 'neg004' => 'neg004_send_with_third_party_notary#create'
+  end
+
   root 'ds_common#index'
 
   # Login starts with POST'ing to: /auth/docusign