Ruby Launcher Code Examples

Github repo: code-examples-ruby

This GitHub repo includes code examples for DocuSign APIs.

To switch between API code examples, modify the examples_API setting at the end of the configuration file. Set only one API type to true and set the remaining to false.

If none of the API types are set to true, the DocuSign eSignature REST API code examples will be shown. If multiple API types are set to true, only the first will be shown.

Note: to use the Rooms API you must also create your DocuSign Developer Account for Rooms.

Introduction

This repo is a Ruby on Rails application that demonstrates:

eSignature API

For more information about the scopes used for obtaining authorization to use the eSignature API, see the Required Scopes section.

Use embedded signing. Source. This example sends an envelope, and then uses embedded signing for the first signer. With embedded signing, the DocuSign signing is initiated from your website.
Request a signature by email (Remote Signing). Source. The envelope includes a pdf, Word, and HTML document. Anchor text (AutoPlace) is used to position the signing fields in the documents.
List envelopes in the user's account. Source. The envelopes' current status is included.
Get an envelope's basic information. Source. The example lists the basic information about an envelope, including its overall status.
List an envelope's recipients Source. Includes current recipient status.
List an envelope's documents. Source.
Download an envelope's documents. Source. The example can download individual documents, the documents concatenated together, or a zip file of the documents.
Programmatically create a template. Source.
Request a signature by email using a template. The example creates an envelope using a template and sets the initial values for some of its tabs (fields). Source.
Send an envelope and upload its documents with multpart binary transfer. Source. Binary transfer is 33% more efficient than using Base64 encoding.
Use embedded sending. Source. Embeds the DocuSign web tool (NDSE) in your web app to finalize or update the envelope and documents before they are sent.
Embedded DocuSign web tool (NDSE). Source.
Use embedded signing from a template with an added document. Source. This example sends an envelope based on a template. In addition to the template's document(s), the example adds an additional document to the envelope by using the Composite Templates feature.
Payments example: an order form, with online payment by credit card. Source.
Get the envelope tab data. Retrieve the tab (field) values for all of the envelope's recipients. Source.
Set envelope tab values. The example creates an envelope and sets the initial values for its tabs (fields). Some of the tabs are set to be read-only, others can be updated by the recipient. The example also stores metadata with the envelope. Source.
Set template tab values. The example creates an envelope using a template and sets the initial values for its tabs (fields). The example also stores metadata with the envelope. Source.
Get the envelope custom field data (metadata). The example retrieves the custom metadata (custom data fields) stored with the envelope. Source.
Requiring an Access Code for a Recipient Source. This example sends an envelope that requires an access-code for the purpose of multi-factor authentication.
Requiring SMS authentication for a recipient Source. This example sends an envelope that requires entering in a six digit code from an text message for the purpose of multi-factor authentication.
Requiring Phone authentication for a recipient Source. This example sends an envelope that requires entering in a voice-based response code for the purpose of multi-factor authentication.
Requiring Knowledge-Based Authentication (KBA) for a Recipient Source. This example sends an envelope that requires passing a Public records check to validate identity for the purpose of multi-factor authentication.
Requiring ID Verification (IDV) for a recipient Source. This example sends an envelope that requires the recipient to upload a government issued id.
Creating a permission profile Source. This code example demonstrates how to create a user group's permission profile using the Create Profile method.
Setting a permission profile Source. This code example demonstrates how to set a user group's permission profile using the Update Group method. You must have already created permissions profile and group of users.
Updating individual permission settings Source. This code example demonstrates how to update individual settings for a specific permission profile using the Update Permission Profile method. You must have already created permissions profile and group of users.
Deleting a permission profile Source. This code example demonstrates how to an account's permission profile using the Delete AccountPermissionProfiles method. You cannot delete the Everyone nor the Administrator profile types as those are defaults.
Creating a brand Source. This example creates brand profile for an account using the Create Brand method.
Applying a brand to an envelope Source. This code example demonstrates how to apply a brand you've created to an envelope using the Create Envelope method. First, creates the envelope and then applies brand to it.
Applying a brand to a template Source. This code example demonstrates how to apply a brand you've created to a template using using the Create Envelope method. You must have at least one created template and brand.
Bulk sending envelopes to multiple recipients Source. This example creates and sends a bulk envelope by generating a bulk recipient list and initiating a bulk send.
Pausing a signature workflow Source. This example demonstrates how to create an envelope where the workflow is paused before the envelope is sent to a second recipient.
Unpausing a signature workflow Source. This example demonstrates how to resume an envelope workflow that has been paused.
Using conditional recipients Source. This example demonstrates how to create an envelope where the workflow is routed to different recipients based on the value of a transaction.
Request a signature by SMS delivery Source. This code example demonstrates how to send a signature request via an SMS message using the Envelopes: create method.

Rooms API

For more information about the scopes used for obtaining authorization to use the Rooms API, see the Required Scopes section.

Create a room with data. Source. This example creates a new room in your DocuSign Rooms account to be used for a transaction.
Create a room from a template. Source. This example creates a new room using a template.
Export data from a room. Source. This example exports all the available data from a specific room in your DocuSign Rooms account.
Add forms to a room. Source. This example adds a standard real estate related form to a specific room in your DocuSign Rooms account.
Search for rooms with filters. Source. This example searches for rooms in your DocuSign Rooms account using a specific filter.
Get an external form fillable session. Source. This example creates an external form that can be filled using DocuSign for a specific room in your DocuSign Rooms account.
Creating a form group. Source. This example creates a new form group with the name given in the name property of the request body.
Grant office access to a form group. Source. This example assigns an office to a form group for your DocuSign Rooms.
Assign a form to a form group. Source. This example assigns a form to a form group for your DocuSign Rooms.

Click API

For more information about the scopes used for obtaining authorization to use the Clickwrap API, see the Required Scopes section.

Creating a clickwrap. Source. This example demonstrates how to use the Click API to create a clickwrap that you can embed in your website or app.
Activate a clickwrap. Source. This example demonstrates how to use the Click API to activate a new clickwrap that you have already created.
Creating a new clickwrap version. Source. This example demonstrates how to use the Click API to create a new version of a clickwrap.
Getting a list of clickwraps. Source. This example demonstrates how to use the Click API to get a list of clickwraps associated with a specific DocuSign user.
Getting clickwrap responses. Source. This example demonstrates how to use the Click API to get a list of clickwraps associated with a specific DocuSign user.

Included OAuth grant types:

Authentication with Docusign via Authorization Code Grant flow . When the token expires, the user is asked to re-authenticate. The refresh token is not used in this example.
Authentication with DocuSign via the JSON Web Token (JWT) Grant. When the token expires, it updates automatically.

Installation

Prerequisites

Note: If you downloaded this code using Quickstart from the DocuSign Developer Center, skip steps 1 and 2 below as they're automatically performed for you.

A DocuSign Developer account (email and password) on demo.docusign.net. Create a free account.
A DocuSign Integration Key and secret key (a client ID). To use JSON Web token, you will need the Integration Key itself, the RSA Secret Key and an API user ID for the user you are impersonating.

You will need the Integration Key itself, and its secret.

The Integration key must include a Redirect URI of

{base_url}/auth/docusign/callback

Where {base_url} is the url for the web app.

By default, the rails app starts on url http://localhost:3000

So the default Redirect URI for your Integration Key is

http://localhost:3000/auth/docusign/callback
Ruby version 2.7.1 or later. Or you can update the Gemfile to use other versions of Ruby.
A name and email for a signer, and a name and email for a cc recipient.

Installation steps

Note: If you downloaded this code using Quickstart from the DocuSign Developer Center, skip steps 4, 5, and 6 below as they're automatically performed for you.

Download or clone this repository to your workstation to directory code-examples-ruby
cd code-examples-ruby
Install the needed gems listed in the Gemfile:

Run bundler install
Copy the file config/appsettings.example.yml into a new file named config/appsettings.yml
Update the file config/appsettings.yml with the Integration Key and other settings. Note: The terms "client_id" and "Integration key" are synonyms. They refer to the same thing.
Update your Integration Key's settings to include a Redirect URI for your installation of the example. See Prerequisites item #2, above for more information.

Run the application

To start the development web server and application:

Run rails s

Note that on Windows additional actions might be necessary:
- Install sqlite3: gem install sqlite3 --platform=ruby
- Download curllib.dll (https://curl.haxx.se/windows/)
- libcurl-x64.dll should be copied as libcurl.dll
- Place libcurl.dll into Ruby C:\\<Ruby installation>\bin
Open a browser to the example's base url to view the index page.

Configuring JWT

Note: Before you can make any API calls using JWT Grant, you must get your user’s consent for your app to impersonate them. To do this, the impersonation scope is added when requesting a JSON Web Token.

Create a developer sandbox account on developers.docusign.com if you don't already have one.
Create a new API key in the Admin panel: https://admindemo.docusign.com/api-integrator-key

Take note of the Integration Key.
Generate a RSA Keypair and copy the private key to a secure location.
Set a Redirect URI of http://localhost:3000/auth/docusign/callback as mentioned in the installation steps above.

Create a new file in the config folder named docusign_private_key.txt, and paste in that copied RSA private key, then save it.
Update the file config/appsettings.yml and include the settings from step 2.

Obtaining consent does not need to be configured, as it is already being done in the code at JwtAuth::JwtCreator#update_token

From there you should be able to run the launcher using bundle exec rails server then selecting JSON Web Token when authenticaing your account.

Troubleshooting Windows SSL issue

When using the Ruby launcher on a Windows machine you may get the following error:

SSL peer certificate or SSH remote key was not OK

This error occurs because you’re attempting to use the Ruby launcher with a self-signed certificate or without SSL/HTTP security. The API calls from Ruby SDKs are using a built-in Curl tool that is enforcing the SSL requirement. You can disable this security check to run the launcher in an insecure manner on your developer machine.

- It is highly recommended that you don’t disable this security check 
- in a production environment or in your integration. 
- This method is offered here solely as a means to enable you to 
- develop quickly by lowering the security bar on your local machine.

Find the root folder for your Ruby gems (in this case, a 64-bit version of Ruby 2.7.0):

C:\Ruby27-x64\lib\ruby\gems\2.7.0\gems\

Find the relevant DocuSign Ruby SDK you are using. The name always starts with “docusign”; for instance, DocuSign Click SDK version 1.0.0:

C:\Ruby27-x64\lib\ruby\gems\2.7.0\gems\docusign_click-1.0.0\lib\docusign_click

Find the configuration.rb file in that folder. Modify the following two lines in the configuration.rb file, replacing true with false:

  @verify_ssl = true
  @verify_ssl_host = true

Once this is complete, you can run your Ruby on Rails application again and you should be able to make API calls on your localhost.

Payments code example

To use the payments example, create a test payments gateway for your developer sandbox account.

See the PAYMENTS_INSTALLATION.md file for instructions.

Then add the payment gateway account id to the config/application.rb file.

Using the examples with other authentication flows

The examples in this repository can also be used with the Implicit grant OAuth flow. See the Authentication guide for information on choosing the right authentication flow for your application.

License and additional information

License

This repository uses the MIT License. See the LICENSE file for more information.

Pull Requests

Pull requests are welcomed. Pull requests will only be considered if their content uses the MIT License.

joemsak/docusign-quickstart