|
1 | | -# The Official DocuSign Ruby Client |
| 1 | +# The Official DocuSign eSignature Ruby Client SDK |
2 | 2 |
|
3 | 3 | [![RubyGems version][rubygems-image]][rubygems-url] |
4 | 4 | [![RubyGems downloads][downloads-image]][downloads-url] |
|
13 | 13 |
|
14 | 14 | - Ruby 1.9+ |
15 | 15 |
|
16 | | -## Note |
17 | | - |
18 | | -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](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below. |
19 | | - |
20 | 16 | ## Installation |
| 17 | +This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/esign-rest-api/how-to/) from the [DocuSign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below. |
21 | 18 |
|
22 | | -### Install via your application's **Gemfile**: |
23 | | - |
24 | | -1. In your application's **Gemfile**, add: |
25 | | - **gem 'docusign_esign'** |
| 19 | +### Installation via your application's Gemfile: |
| 20 | +1. In your application's Gemfile, add: |
| 21 | + `gem 'docusign_esign'` |
26 | 22 | 2. Open your preferred console. |
27 | | -3. In your project directory, execute the installer by typing: |
28 | | - **bundle install** |
29 | | - |
30 | | -### Manual install: |
| 23 | +3. In your project directory, execute the installer by typing: **bundle install** |
31 | 24 |
|
| 25 | +### Manual installation: |
32 | 26 | 1. Open your preferred console. |
33 | | -2. In the console, type: |
34 | | - **gem install docusign_esign** |
| 27 | +2. In the console, type: **gem install docusign_esign** |
35 | 28 |
|
36 | 29 | ### Dependencies |
37 | | - |
38 | 30 | This client has the following external dependencies: |
| 31 | +* Jwt>=1.5.2 |
| 32 | +* Json>=2.1.0 |
| 33 | +* Typhoeus>=1.0.1 |
39 | 34 |
|
40 | | -- Jwt>=1.5.2 |
41 | | -- Json>=2.1.0 |
42 | | -- Typhoeus>=1.0.1 |
43 | | - |
44 | | -## Code Examples |
45 | | - |
46 | | -### Launchers |
| 35 | +## Code examples |
| 36 | +You can find on our GitHub a self-executing package of code examples for the eSignature C# SDK, called a [Launcher](https://github.com/docusign/code-examples-ruby/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows. |
47 | 37 |
|
48 | | -DocuSign provides a sample application referred to as a [Launcher](https://github.com/docusign/eg-03-ruby-auth-code-grant). The Launcher contains a set of 14 common use cases and associated source files. These examples use DocuSign's [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow. |
49 | | - |
50 | | -### Proof-of-concept applications |
51 | | - |
52 | | -If your goal is to create a proof-of-concept application, DocuSign provides a set of [Quick Start](https://github.com/docusign/qs-ruby) examples. The Quick Start examples are meant to be used with DocuSign's [OAuth Token Generator](https://developers.docusign.com/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. |
53 | | - |
54 | | -## OAuth Implementations |
55 | | - |
56 | | -For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/esign-rest-api/guides/authentication). |
| 38 | +## OAuth implementations |
| 39 | +For details regarding which type of OAuth grant will work best for your DocuSign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [DocuSign Developer Center](https://developers.docusign.com/). |
57 | 40 |
|
58 | 41 | For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow. |
59 | 42 |
|
60 | | -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](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) and [Implicit](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-implicit) grants. For code examples, see the links below: |
61 | | - |
62 | | -- [JWT (JSON Web Token)](https://github.com/docusign/eg-03-ruby-auth-code-grant) |
63 | | -- Implicit Grant (coming soon) |
64 | | - |
65 | 43 | ## Support |
66 | | - |
67 | 44 | Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi). |
68 | 45 |
|
69 | 46 | ## License |
| 47 | +The DocuSign eSignature Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE). |
70 | 48 |
|
71 | | -The DocuSign Ruby Client is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE). |
| 49 | +### Additional resources |
| 50 | +* [DocuSign Developer Center](https://developers.docusign.com/) |
| 51 | +* [DocuSign API on Twitter](https://twitter.com/docusignapi) |
| 52 | +* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/) |
| 53 | +* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ) |
72 | 54 |
|
73 | 55 | [rubygems-image]: https://img.shields.io/gem/v/docusign_esign.svg?style=flat |
74 | 56 | [rubygems-url]: https://rubygems.org/gems/docusign_esign |
75 | 57 | [downloads-image]: https://img.shields.io/gem/dt/docusign_esign.svg?style=flat |
76 | 58 | [downloads-url]: https://rubygems.org/gems/docusign_esign |
77 | 59 | [travis-image]: https://img.shields.io/travis/docusign/docusign-ruby-client.svg?style=flat |
78 | | -[travis-url]: https://travis-ci.org/docusign/docusign-ruby-client |
| 60 | +[travis-url]: https://travis-ci.org/docusign/docusign-ruby-client |
0 commit comments