docusign_rest 0.0.2 → 0.0.3

Sign up to get free protection for your applications and to get access to all the features.
data/README.md CHANGED
@@ -54,8 +54,23 @@ outputs:
54
54
  config.password = 'p@ssw0rd1'
55
55
  config.integrator_key = 'KEYS-19ddd1cc-cb56-4ca6-87ec-38db47d14b32'
56
56
  config.account_id = '123456'
57
+ #config.endpoint = 'https://docusign.net'
58
+ #config.api_version = 'v1'
57
59
  end
58
60
 
61
+
62
+ ### Config Options
63
+
64
+ There are several other configuration options available but the two most likely to be needed are:
65
+
66
+ ```ruby
67
+ config.endpoint = 'https://docusign.net'
68
+ config.api_version = 'v1'
69
+ ```
70
+
71
+ The above options allow you to change the endpoint (to be able to hit the production DocuSign API, for instance) and to modify the API version you wish to use. If there is a big change in the API it's likely that this gem will need to be updated to leverage changes on the DocuSign side. However, it doesn't hurt to provide the option in case there are several minor updates that do not break functionality but would otherwise require a new gem release. These config options have existed since the gem was created, but in v0.0.3 and above, the options are auto-generated in the config file as comments to make them easier to discover.
72
+
73
+
59
74
  ## Usage
60
75
 
61
76
  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).
@@ -105,7 +120,6 @@ response = client.create_envelope_from_document(
105
120
  status: 'sent'
106
121
  )
107
122
  response = JSON.parse(response.body)
108
- response["status"].must_equal "sent"
109
123
  ```
110
124
 
111
125
 
@@ -1,3 +1,3 @@
1
1
  module DocusignRest
2
- VERSION = "0.0.2"
2
+ VERSION = "0.0.3"
3
3
  end
@@ -46,6 +46,8 @@ DocusignRest.configure do |config|
46
46
  config.password = '#{password}'
47
47
  config.integrator_key = '#{integrator_key}'
48
48
  config.account_id = '#{acct_id}'
49
+ #config.endpoint = 'https://docusign.net'
50
+ #config.api_version = 'v1'
49
51
  end\n\n}
50
52
 
51
53
  # write the initializer for the user
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: docusign_rest
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.2
4
+ version: 0.0.3
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors: