Merge branch 'master' of github.com:docusign/code-examples-ruby-private

Author: karissarjacobsen

app/controllers/e_sign/eg039_signing_in_person_controller.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class ESign::Eg039SigningInPersonController < EgController
+  def create
+    minimum_buffer_min = 10
+    token_ok = check_token(minimum_buffer_min)
+    unless token_ok
+      flash[:messages] = 'Sorry, you need to re-authenticate.'
+      # We could store the parameters of the requested operation
+      # so it could be restarted automatically.
+      # But since it should be rare to have a token issue here,
+      # we'll make the user re-enter the form data after
+      # authentication.
+      return redirect_to '/ds/mustAuthenticate'
+    end
+
+    access_token = session[:ds_access_token]
+    base_path = session[:ds_base_path]
+    email = ESign::GetDataService.new(access_token, base_path).get_current_user_email
+    name = ESign::GetDataService.new(access_token, base_path).get_current_user_name
+
+    args = {
+      account_id: session[:ds_account_id],
+      base_path: session[:ds_base_path],
+      access_token: session[:ds_access_token],
+      host_email: param_gsub(email),
+      host_name: param_gsub(name),
+      signer_name: param_gsub(params[:signer_name]),
+      ds_ping_url: Rails.application.config.app_url,
+      pdf_filename: 'data/World_Wide_Corp_lorem.pdf'
+    }
+
+    redirect_url = ESign::Eg039SigningInPersonService.new(args).worker
+    redirect_to redirect_url
+  end
+end

app/services/e_sign/eg039_signing_in_person_service.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+class ESign::Eg039SigningInPersonService
+  attr_reader :args
+  include ApiCreator
+
+  def initialize(args)
+    @args = args
+  end
+
+  # ***DS.snippet.0.start
+  def worker
+    ds_ping_url = args[:ds_ping_url]
+    ds_return_url = "#{ds_ping_url}/ds_common-return"
+    pdf_filename = args[:pdf_filename]
+    host_email = args[:host_email]
+    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
+    envelope_api = create_envelope_api(args)
+
+    results = envelope_api.create_envelope args[:account_id], envelope
+    envelope_id = results.envelope_id
+
+    # Step 3. Create the recipient view for the embedded signing
+    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 4. 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)
+    # Redirect to results.url
+    results.url
+  end
+
+  private
+
+  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
+    # should typically be a callback route somewhere in your app.
+    # The query parameter is included as an example of how
+    # to save/recover state information during the redirect to
+    # the DocuSign signing. It's usually better to use
+    # the session mechanism of your web framework. Query parameters
+    # can be changed/spoofed very easily.
+    view_request.return_url = ds_return_url + '?state=123'
+
+    # How has your app authenticated the user? In addition to your app's
+    # authentication, you can include authenticate steps from DocuSign;
+    # e.g., SMS authentication
+    view_request.authentication_method = 'none'
+
+    # Recipient information must match the embedded recipient info
+    # that was used to create the envelope
+    view_request.email = host_email
+    view_request.user_name = host_name
+
+    # DocuSign recommends that you redirect to DocuSign for the embedded signing. There are
+    # multiple ways to save state. To maintain your application's session, use the pingUrl
+    # parameter. It causes the DocuSign signing web page (not the DocuSign server)
+    # to send pings via AJAX to your app
+    view_request.ping_frequency = '600' # seconds
+    # NOTE: The pings will only be sent if the pingUrl is an HTTPS address
+    view_request.ping_url = ds_ping_url # Optional setting
+
+    view_request
+  end
+
+  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'
+
+    doc1 = DocuSign_eSign::Document.new
+    doc1.document_base64 = Base64.encode64(File.binread(pdf_filename))
+    doc1.name = 'Lorem Ipsum'
+    doc1.file_extension = 'pdf'
+    doc1.document_id = '1'
+
+    # The order in the docs array determines the order in the envelope
+    envelope_definition.documents = [doc1]
+    # Create an in person signer recipient to sign the document
+    # We're setting the parameters via the object creation
+
+    in_person_signer = DocuSign_eSign::InPersonSigner.new
+    in_person_signer.host_email = host_email
+    in_person_signer.host_name = host_name
+    in_person_signer.signer_name = signer_name
+    in_person_signer.recipient_id = '1'
+    in_person_signer.routing_order = '1'
+
+    # The DocuSign platform searches throughout your envelope's documents for matching
+    # anchor strings.
+    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'
+    # Tabs are set per recipient/signer
+    tabs = DocuSign_eSign::Tabs.new
+    tabs.sign_here_tabs = [sign_here]
+    in_person_signer.tabs = tabs
+    # Add the recipients to the envelope object
+    recipients = DocuSign_eSign::Recipients.new
+    recipients.in_person_signers = [in_person_signer]
+
+    envelope_definition.recipients = recipients
+    # 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.status = 'sent'
+    envelope_definition
+  end
+  # ***DS.snippet.0.end
+end

app/services/e_sign/get_data_service.rb

@@ -0,0 +1,44 @@
+class ESign::GetDataService
+  attr_reader :args
+
+  def initialize(access_token, base_path)
+    @args = {
+      access_token: access_token,
+      base_path: base_path
+    }
+  end
+
+  def get_current_user_email
+    worker
+
+    user_info = @api_client.get_user_info(args[:access_token])
+    unless user_info
+      raise "The user does not have access to account"
+    end
+
+    user_info.email
+  end
+
+  def get_current_user_name
+    worker
+
+    user_info = @api_client.get_user_info(args[:access_token])
+    unless user_info
+      raise "The user does not have access to account"
+    end
+
+    user_info.name
+  end
+
+  private
+
+  def worker
+    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]}")
+
+  end
+end