Skip to content

Commit 0ff9b0c

Browse files
author
Balaji Jayaraman
committed
added quick_acg quickstart ruby version fix
1 parent 8e19836 commit 0ff9b0c

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,14 @@ For a list of code examples that use the Admin API, see the [How-to guides overv
9292

9393
1. [Ruby version 2.7.2](https://www.ruby-lang.org/en/downloads/) or later
9494
1. Update the Gemfile to use later versions of Ruby.
95+
1. Update the **.ruby-version** to use your preferred version of Ruby. Ruby version managers may automatically switch your Ruby version to what is specified in .ruby-version file.
9596
1. Windows x64 only:
9697
1. Ensure that your Ruby folder is appended with **-x64**, e.g. **Ruby27-x64**
9798
2. Install Curl for Ruby: [Download libcurl.dll](https://curl.haxx.se/windows/)
9899
Save **libcurl-x64.dll** as **libcurl.dll**
99100
Place **libcurl.dll** in your Ruby folder, e.g. **C:\Ruby27-x64\bin**
101+
3. **Git Bash is not recommended**: it can cause issues with interactive input/output, signal handling, and path/quoting differences.
102+
Use WSL or the VS Code integrated Bash terminal instead
100103

101104

102105
### Installation steps
@@ -105,6 +108,7 @@ For a list of code examples that use the Admin API, see the [How-to guides overv
105108
1. Extract the Quickstart ZIP file, or download or clone the code-examples-ruby repository.
106109
1. In your command-line environment, switch to the folder:
107110
`cd <Quickstart folder>` or `cd code-examples-ruby`
111+
1. Adjust Ruby version in **Gemfile** and **.ruby-version**
108112
1. To install dependencies, run: `bundler install`
109113
1. To configure the launcher for [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) authentication, create a copy of the file config/appsettings.example.yml and save the copy as config/appsettings.yml.
110114
1. Add your integration key. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **Apps and Integration Keys**, choose the app to use, then select **Actions** > **Edit**. Under **General Info**, copy the **Integration Key** GUID and save it in appsettings.yml as your `integration_key`.
@@ -123,6 +127,7 @@ Also, in order to select JSON Web Token authentication in the launcher, in confi
123127
1. Extract the Quickstart ZIP file or download or clone the code-examples-ruby repository.
124128
1. In your command-line environment, switch to the folder:
125129
`cd <Quickstart folder>` or `cd code-examples-ruby`
130+
1. Adjust Ruby version in **Gemfile** and **.ruby-version**
126131
1. Install the dependencies: `bundler install`
127132
1. To configure the launcher for [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication, create a copy of the file config/appsettings.example.yml and save the copy as config/appsettings.yml.
128133
1. Add your User ID. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **My Account Information**, copy the **User ID** GUID and save it in appsettings.yml as your `impersonated_user_guid`.
@@ -141,7 +146,7 @@ Also, in order to select JSON Web Token authentication in the launcher, in confi
141146
See [Docusign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the Docusign Developer Center for more information on how to run the JWT grant remote signing project and the Authorization Code Grant embedded signing project.
142147

143148
### Authorization Code Grant embedded signing example:
144-
Run in Git Bash:
149+
Run in terminal:
145150
```
146151
$ cd <Quickstart folder>/quick_acg
147152
$ bundler install
@@ -151,7 +156,7 @@ $ rails s
151156
Open a browser to http://localhost:3000
152157

153158
### JWT grant remote signing example:
154-
Run in Windows Command Prompt (CMD):
159+
Run in terminal:
155160
```
156161
$ cd jwt_console_project
157162
$ ruby jwt_console.rb

quick_acg/.ruby-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
ruby-2.7.3
1+
3.1.2

0 commit comments

Comments
 (0)