docusign_rest 0.0.1 → 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +3 -3
- data/lib/docusign_rest/version.rb +1 -1
- metadata +1 -1
data/README.md
CHANGED
@@ -24,7 +24,7 @@ There is a bundled rake task that will prompt you for your DocuSign credentials
|
|
24
24
|
* Password
|
25
25
|
* Integrator Key
|
26
26
|
|
27
|
-
and create the `config/initializers/
|
27
|
+
and create the `config/initializers/docusign_rest.rb` file in your Rails app for you. If the file was unable to be created, the rake task will output the config block for you to manually add to an initializer.
|
28
28
|
|
29
29
|
**Note** please run the below task and ensure your initializer is in place before attempting to use any of the methods in this gem. Without the initializer this gem will not be able to properly authenticate you to the DocuSign REST API.
|
30
30
|
|
@@ -58,7 +58,7 @@ outputs:
|
|
58
58
|
|
59
59
|
## Usage
|
60
60
|
|
61
|
-
The docusign\_rest gem makes creating multipart POST (aka file upload) requests to the DocuSign REST API dead simple. It's built on top of Net:HTTP and utilizes the [multipart-post](https://github.com/nicksieger/multipart-post) gem to assist with formatting the multipart requests
|
61
|
+
The docusign\_rest gem makes creating multipart POST (aka file upload) requests to the DocuSign REST API dead simple. It's built on top of Net:HTTP and utilizes the [multipart-post](https://github.com/nicksieger/multipart-post) gem to assist with formatting the multipart requests. The DocuSign REST API requires that all files be embedded as JSON directly in the request body (not the body\_stream like multipart-post does by default) so the docusign\_rest gem takes care of [setting that up for you](https://github.com/j2fly/docusign_rest/blob/master/lib/docusign_rest/client.rb#L397).
|
62
62
|
|
63
63
|
This gem also monkey patches one small part of multipart-post to inject some header values and formatting that DocuSign requires. If you would like to see the monkey patched code please take a look at [lib/multipart-post/parts.rb](https://github.com/j2fly/docusign_rest/blob/master/lib/multipart_post/parts.rb). It's only re-opening one method, but feel free to make sure you understand that monkey patch if it concerns you.
|
64
64
|
|
@@ -186,7 +186,7 @@ In order to run the tests you'll need to register for a (free) DocuSign develope
|
|
186
186
|
|
187
187
|
$ ruby lib/tasks/docusign_task.rb
|
188
188
|
|
189
|
-
This calls a rake task which adds a non-version controlled file in the test folder called
|
189
|
+
This calls a rake task which adds a non-version controlled file in the test folder called `docusign_login_config.rb` which holds your account specific credentials and is required in order to hit the test API through the test suite.
|
190
190
|
|
191
191
|
**VCR**
|
192
192
|
|