The Official DocuSign Ruby Client

Requirements

• Ruby 1.9+
• Free Developer Sandbox

Compatibility

• Ruby 1.9+

Note

This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the Developer Center, follow the installation instructions below.

Installation

Install via your application's Gemfile:

1. In your application's Gemfile, add:
   gem 'docusign_esign'
2. Open your preferred console.
3. In your project directory, execute the installer by typing:
   bundle install

Manual install:

1. Open your preferred console.
2. In the console, type:
   gem install docusign_esign

Dependencies

This client has the following external dependencies:

• Jwt>=1.5.2
• Json>=1.8.3
• Typhoeus>=1.0.1

Code Examples

Launchers

DocuSign provides a sample application referred to as a Launcher. The Launcher contains a set of 14 common use cases and associated source files. These examples use DocuSign's Authorization Code Grant flow.

Proof-of-concept applications

If your goal is to create a proof-of-concept application, DocuSign provides a set of Quick Start examples. The Quick Start examples are meant to be used with DocuSign's OAuth Token Generator, which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.

OAuth Implementations

For details regarding which type of OAuth grant will work best for your DocuSign integration, see the REST API Authentication Overview guide located on the DocuSign Developer Center.

For security purposes, DocuSign recommends using the Authorization Code Grant flow.

There are other use-case scenarios, such as single-page applications (SPA) that use Cross-Origin Resource Sharing (CORS), or where there may not be a user to interact with your Service Account. For these use cases, DocuSign also supports JWT and Implicit grants. For code examples, see the links below:

• JWT (JSON Web Token)
• Implicit Grant (coming soon)

Support

Log issues against this client through GitHub. We also have an active developer community on Stack Overflow.

License

The DocuSign Ruby Client is licensed under the MIT License.