docusign_rest 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e077e5af78df26b9158e39d0a37b138693f9634
-  data.tar.gz: 566af05a3a7a3c1fe7dc351f7e25a168f62a2b5a
+  metadata.gz: 67460cc1df129f721affa3f822e3019a0b648be3
+  data.tar.gz: 461927419841a056220b26a8ee9ff64c1ef20d54
 SHA512:
-  metadata.gz: d2710846c68cc0cb9a9f09b5b77b9645e57d36dac7a679247f8792fe51f277a3af372bee303a72cb3e853cebd36348b8899483df1cdd6d8e7fbb782fa8cb1ce5
-  data.tar.gz: 326e18ab520f022027393a9648953bc5046a7aae5d03fea5924e9d06294168b825825642c6a6a7ee7d1811e8cb24300ea77a03e8c574fb76d6343c442ff46ca8
+  metadata.gz: 6e7c0c96f3a815fb4048db7f8379e36df690c5dd1884f346a93863efc8f0937fd79aaf5b3fdd6c98ee9ae86f10e5769601262b7b99c455750d1f87475f7d849d
+  data.tar.gz: 3a3f5bcac8407d7be4b43f217f34d90114b718b06e0935dbd79bb5f171b475bc3fdafdbbe27bcebeefd51fca6407448cf088cbf03d10dee12219548b498ec250

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## v0.3.0 May 11 2017
+
+### Features:
+* Add brandId and allow_reassign options to DocusignRest::Client#create_envelope_from_template and DocusignRest::Client#create_envelope_from_composite_template (Jayan Jacob)
+* Implement DocusignRest::Client#add_envelope_certified_deliveries (Moses Dwaram)
+* Add envelopeIds option to DocusignRest::Client#get_envelope_statuses (Amit Chakradeo)
+* Add recipientEvents option to event notification payload (Guillermo Wu)
+* Added logging of each call to support Docusign API certification (Jon Witucki)
+* Enable requireSignOnPaper option for a recipient in a composite template (Tom Copeland)
+* Support routingOrder option when generating signers (Guillaume Dott)
+* Support arbitrary parameters to DocusignRest::Client#get_combined_document_from_envelope (Coley Brown)
+* Support event notifications in DocusignRest::Client#get_combined_document_from_envelope (Maxime Orefice)
+* Support wet_sign option on DocusignRest::Client#create_envelope_from_document (Sergio Cambra)
+* Support signHereTabs on DocusignRest::Client#get_inline_signers (Chris Sturm)
+* Support additional tab options (Hoang Le)
+
+### Misc:
+* Replace monkeypatch with argument usage (Jean-Philippe Moal)
+* Bumped minimum Ruby version to 2.1.0. (Tom Copeland)
+* DocusignRest::Client#void_envelope now returns a JSON object rather than a request object (Tom Copeland)
+
 ## v0.2.0 April 28 2017
 
 ### Features:

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Jon Kinney
+Copyright (c) 2012-2017 Jon Kinney
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
 # DocusignRest
 
-This 'wrapper gem' hooks a Ruby app (currently only tested with Rails) up to the [DocuSign](http://www.docusign.com/) [REST API](http://www.docusign.com/developer-center) to allow for embedded signing.
+This 'wrapper gem' hooks a Ruby app (currently only tested with Rails) up to the [DocuSign](http://www.docusign.com/) REST API ([docs](https://docs.docusign.com/esign/), [API explorer](https://apiexplorer.docusign.com/#/esign/restapi)) to allow for embedded signing.
 
 ## Installation
 
@@ -65,23 +65,38 @@ There are several other configuration options available but the two most likely
 
 ```ruby
 config.endpoint       = 'https://docusign.net/restapi'
-config.api_version    = 'v1'
+config.api_version    = 'v2'
 ```
 
-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.
-
+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.
 
 ## Usage
 
-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).
-
-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 code if it concerns you.
+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).
 
 ### Examples
 
-* These examples assume you have already run the `docusign_rest:generate_config` rake task and have the configure block properly setup in an initializer with your username, password, integrator\_key, and account\_id.
 * Unless noted otherwise, these requests return the JSON parsed body of the response so you can index the returned hash directly. For example: `template_response["templateId"]`.
 
+#### Situations
+
+** In the context of a Rails app **
+
+This is how most people are using this gem - they've got a Rails app that's doing things with the Docusign API.  In that case, these examples assume you have already set up a docusign account, have run the `docusign_rest:generate_config` rake task, and have the configure block properly setup in an initializer with your username, password, integrator\_key, and account\_id.
+
+** In the context of this gem as a standalone project **
+
+Ideally this gem will be independent of Rails.  If that's your situation, there won't be a Rails initializer so your code will need to load the API authentication credentials.  You will want to do something like:
+
+```ruby
+load 'test/docusign_login_config.rb'
+client = DocusignRest::Client.new
+client.get_account_id
+document_envelope_response = client.create_envelope_from_document( # etc etc
+```
+
+#### Example code
+
 **Getting account_id:**
 
 ```ruby
@@ -89,10 +104,45 @@ client = DocusignRest::Client.new
 puts client.get_account_id
 ```
 
-
 **Creating an envelope from a document:**
 
-Note: In the example below there are two sign here tabs for the user with a role of 'Attorney'. There are also two documents attached to the envelope, however, this exact configuration would only allow for signature on the first document. If you need signature for a second document, you'll need to add further options, namely: `document_id: 2` in one of the sign_here_tabs so that DocuSign knows where to embed that signature tab.
+Here's how to create an envelope from a local PDF file and open a browser to the URL for the recipient:
+
+```ruby
+client = DocusignRest::Client.new
+document_envelope_response = client.create_envelope_from_document(
+  email: {
+    subject: "test email subject",
+    body: "this is the email body and it's large!"
+  },
+  # If embedded is set to true in the signers array below, emails
+  # don't go out to the signers and you can embed the signature page in an
+  # iframe by using the client.get_recipient_view method
+  signers: [
+    {
+      embedded: true,
+      name: 'Joe Dimaggio',
+      email: 'joe.dimaggio@example.org',
+      role_name: 'Issuer',
+      sign_here_tabs: [
+        {
+          anchor_string: 'sign here',
+          anchor_x_offset: '-30',
+          anchor_y_offset: '35'
+        }
+      ]
+    },
+  ],
+  files: [
+    {path: '/Absolute/path/to/test.pdf', name: 'test.pdf'},
+  ],
+  status: 'sent'
+)
+url = client.get_recipient_view(envelope_id: document_envelope_response['envelopeId'], name: "Joe Dimaggio", email: "joe.dimaggio@example.org", return_url: 'http://google.com')['url']
+`open #{url}`
+```
+
+Note: In the example below there are two sign here tabs for the user with a role of 'Attorney'. There are also two documents attached to the envelope, however, this exact configuration would only allow for signature on the first document. If you need signature for a second document, you'll need to add further options, namely: `document_id: 2` in one of the `sign_here_tabs` so that DocuSign knows where to embed that signature tab.
 
 ```ruby
 client = DocusignRest::Client.new
@@ -103,7 +153,7 @@ document_envelope_response = client.create_envelope_from_document(
   },
   # If embedded is set to true  in the signers array below, emails
   # don't go out to the signers and you can embed the signature page in an
-  # iFrame by using the client.get_recipient_view method
+  # iframe by using the client.get_recipient_view method
   signers: [
     {
       embedded: true,
@@ -112,9 +162,9 @@ document_envelope_response = client.create_envelope_from_document(
       role_name: 'Issuer',
       sign_here_tabs: [
         {
-          anchor_string: 'sign_here_1',
-          anchor_x_offset: '140',
-          anchor_y_offset: '8'
+          anchor_string: 'sign here',
+          anchor_x_offset: '-30',
+          anchor_y_offset: '35'
         }
       ]
     },
@@ -218,8 +268,6 @@ client = DocusignRest::Client.new
 
 **Creating an envelope from a template using custom tabs:**
 
-Note: This feature is not supported in 'v1' of the REST API
-
 ```ruby
 client = DocusignRest::Client.new
 @envelope_response = client.create_envelope_from_template(
@@ -296,14 +344,14 @@ client.get_document_from_envelope(
 )
 ```
 
-## Breaking out of the iFrame after signing
+## Breaking out of the iframe after signing
 
-In order to return to your application after the signing process is complete it's important to have a way to evaluate whether or not the signing was successful and then do something about each case. The way I set this up was to render the embedded signing iframe for a controller action called 'embedded_signing' and specify the return_url of the `client.get_recipient_view` API call to be something like: http://myapp.com/docusign_response. Then in the same controller as the embedded_signing method, define the docusign_response method. This is where the signing process will redirect to after the user is done interacting with the DocuSign iframe. DocuSign passes a query string parameter in the return_url named 'event' and you can check like so: `if params[:event] == "signing_complete"` then you'll want to redirect to another spot in your app, not in the iframe. To do so, we need to use JavaScript to access the iframe's parent and set it's location to the path of our choosing. To do this, instanciate the DocusignRest::Utility class and call the breakout_path method like this:
+In order to return to your application after the signing process is complete it's important to have a way to evaluate whether or not the signing was successful and then do something about each case. The way I set this up was to render the embedded signing iframe for a controller action called 'embedded_signing' and specify the return_url of the `client.get_recipient_view` API call to be something like: http://myapp.com/docusign_response. Then in the same controller as the embedded_signing method, define the docusign_response method. This is where the signing process will redirect to after the user is done interacting with the DocuSign iframe. DocuSign passes a query string parameter in the return_url named 'event' and you can check like so: `if params[:event] == "signing_complete"` then you'll want to redirect to another spot in your app, not in the iframe. To do so, we need to use JavaScript to access the iframe's parent and set it's location to the path of our choosing. To do this, instantiate the `DocusignRest::Utility` class and call the breakout_path method like this:
 
 ```ruby
 class SomeController < ApplicationController
 
-  # the view corresponding to this action has the iFrame in it with the
+  # the view corresponding to this action has the iframe in it with the
   # @url as it's src. @envelope_response is populated from either:
   # @envelope_response = client.create_envelope_from_document
   # or
@@ -349,10 +397,6 @@ In order to run the tests you'll need to register for a (free) DocuSign develope
 
 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.
 
-**Guard**
-
-Simply run 'guard' from the root directory of the repository to have the test suite executed automatically as you make changes.
-
 **VCR**
 
 The test suite uses VCR and is configured to record all requests by using the 'all' configuration option surrounding each API request. If you want to speed up the test suite locally for new feature development, you may want to change the VCR config record setting to 'once' temporarily which will not write a new YAML file for each request each time you hit the API and significantly speed up the tests. However, this can lead to false passing tests as the gem changes so it's recommended that you ensure all tests pass by actually hitting the API before submitting a pull request.

data/docusign_rest.gemspec

@@ -2,27 +2,25 @@
 require File.expand_path('../lib/docusign_rest/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Jon Kinney']
-  gem.email         = ['jonkinney@gmail.com']
+  gem.authors       = ['Jon Kinney', 'Tom Copeland']
+  gem.email         = ['jonkinney@gmail.com', 'tom@thomasleecopeland.com']
   gem.description   = %q{Hooks a Rails app up to the DocuSign service through the DocuSign REST API}
   gem.summary       = %q{Use this gem to embed signing of documents in a Rails app through the DocuSign REST API}
   gem.homepage      = "https://github.com/jondkinney/docusign_rest"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files         = `git ls-files -z`.split("\x0").reject {|p| p.match(%r{^(test/|test.*pdf|cacert.pem|.gitignore)}) }
   gem.name          = 'docusign_rest'
   gem.require_paths = ['lib']
   gem.version       = DocusignRest::VERSION
   gem.licenses      = ['MIT']
 
-  gem.required_ruby_version = '>= 1.9.2'
+  gem.required_ruby_version = '>= 2.1.0'
 
   gem.add_dependency('multipart-post', '>= 1.2')
   gem.add_dependency('json')
   gem.add_development_dependency('rake')
+  gem.add_development_dependency('byebug')
   gem.add_development_dependency('minitest', '~> 4.0')
-  gem.add_development_dependency('guard-minitest')
   gem.add_development_dependency('rb-fsevent', '~> 0.9')
   gem.add_development_dependency('turn')
   gem.add_development_dependency('pry')

data/lib/docusign_rest.rb

@@ -4,7 +4,6 @@ require_relative 'docusign_rest/client'
 require_relative 'docusign_rest/utility'
 require 'multipart_post' #require the multipart-post gem itself
 require 'net/http/post/multipart' #require the multipart-post net/http/post/multipart monkey patch
-require_relative 'multipart_post/parts' #require my monkey patched parts.rb which adjusts the build_part method
 require 'net/http'
 require 'json'
 

data/lib/docusign_rest/client.rb

@@ -7,6 +7,7 @@ module DocusignRest
     # Define the same set of accessors as the DocusignRest module
     attr_accessor *Configuration::VALID_CONFIG_KEYS
     attr_accessor :docusign_authentication_headers, :acct_id
+    attr_accessor :previous_call_log
 
     def initialize(options={})
       # Merge the config values from the module and those passed to the client.
@@ -38,6 +39,9 @@ module DocusignRest
       # the instance var @account_id because that'll override the attr_accessor
       # that is automatically configured for the configure block
       @acct_id = account_id
+
+      #initialize the log cache
+      @previous_call_log = []
     end
 
 
@@ -143,6 +147,7 @@ module DocusignRest
 
       http = initialize_net_http_ssl(uri)
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -169,7 +174,9 @@ module DocusignRest
       uri = build_uri('/login_information')
       request = Net::HTTP::Get.new(uri.request_uri, headers(options[:headers]))
       http = initialize_net_http_ssl(uri)
-      http.request(request)
+      response = http.request(request)
+      generate_log(request, response, uri)
+      response
     end
 
 
@@ -200,7 +207,7 @@ module DocusignRest
     # hashes with commas
     #
     # embedded -  Tells DocuSign if this is an embedded signer which determines
-    #             weather or not to deliver emails. Also lets us authenticate
+    #             whether or not to deliver emails. Also lets us authenticate
     #             them when they go to do embedded signing. Behind the scenes
     #             this is setting the clientUserId value to the signer's email.
     # name      - The name of the signer
@@ -209,8 +216,6 @@ module DocusignRest
     # tabs      - Array of tab pairs grouped by type (Example type: 'textTabs')
     #             { textTabs: [ { tabLabel: "label", name: "name", value: "value" } ] }
     #
-    #             NOTE: The 'tabs' option is NOT supported in 'v1' of the REST API
-    #
     # Returns a hash of users that need to be embedded in the template to
     # create an envelope
     def get_template_roles(signers)
@@ -239,6 +244,17 @@ module DocusignRest
       template_roles
     end
 
+    def get_sign_here_tabs(tabs)
+      Array(tabs).map do |tab|
+        {
+          documentId: tab[:document_id],
+          recipientId: tab[:recipient_id],
+          anchorString: tab[:anchor_string],
+          anchorXOffset: tab[:anchorXOffset],
+          anchorYOffset: tab[:anchorYOffset]
+        }
+      end
+    end
 
     # TODO (2014-02-03) jonk => document
     def get_signer_tabs(tabs)
@@ -260,14 +276,20 @@ module DocusignRest
       return {} unless event_notification
       {
         useSoapInterface:          event_notification[:use_soap_interface] || false,
-        includeCertificatWithSoap: event_notification[:include_certificate_with_soap] || false,
+        includeCertificateWithSoap: event_notification[:include_certificate_with_soap] || false,
         url:                       event_notification[:url],
         loggingEnabled:            event_notification[:logging],
-        'EnvelopeEvents' => Array(event_notification[:envelope_events]).map do |envelope_event|
+        'envelopeEvents' => Array(event_notification[:envelope_events]).map do |envelope_event|
           {
             includeDocuments:        envelope_event[:include_documents] || false,
             envelopeEventStatusCode: envelope_event[:envelope_event_status_code]
           }
+        end,
+        'recipientEvents' => Array(event_notification[:recipient_events]).map do |recipient_event|
+          {
+            includeDocuments:         recipient_event[:include_documents] || false,
+            recipientEventStatusCode: recipient_event[:recipient_event_status_code]
+          }
         end
       }
     end
@@ -283,7 +305,7 @@ module DocusignRest
     # email              - The signer's email
     # name               - The signer's name
     # embedded           - Tells DocuSign if this is an embedded signer which
-    #                      determines weather or not to deliver emails. Also
+    #                      determines whether or not to deliver emails. Also
     #                      lets us authenticate them when they go to do
     #                      embedded signing. Behind the scenes this is setting
     #                      the clientUserId value to the signer's email.
@@ -312,7 +334,7 @@ module DocusignRest
           name:                                  signer[:name],
           accessCode:                            '',
           addAccessCodeToEmail:                  false,
-          customFields:                          nil,
+          customFields:                          signer[:custom_fields],
           iDCheckConfigurationName:              nil,
           iDCheckInformationInput:               nil,
           inheritEmailNotificationConfiguration: false,
@@ -322,7 +344,7 @@ module DocusignRest
           recipientId:                           "#{index + 1}",
           requireIdLookup:                       false,
           roleName:                              signer[:role_name],
-          routingOrder:                          index + 1,
+          routingOrder:                          signer[:routing_order] || index + 1,
           socialAuthentications:                 nil
         }
 
@@ -355,7 +377,7 @@ module DocusignRest
           fullNameTabs:         get_tabs(signer[:full_name_tabs], options, index),
           listTabs:             get_tabs(signer[:list_tabs], options, index),
           noteTabs:             nil,
-          numberTabs:           nil,
+          numberTabs:           get_tabs(signer[:number_tabs], options, index),
           radioGroupTabs:       get_tabs(signer[:radio_group_tabs], options, index),
           initialHereTabs:      get_tabs(signer[:initial_here_tabs], options.merge!(initial_here_tab: true), index),
           signHereTabs:         get_tabs(signer[:sign_here_tabs], options.merge!(sign_here_tab: true), index),
@@ -373,6 +395,72 @@ module DocusignRest
     end
 
 
+    # Internal: people to be Carbon Copied on the document that is created
+    # https://docs.docusign.com/esign/restapi/Envelopes/Envelopes/create/
+    #
+    # Expecting options to be an array of hashes, with each hash representing a person to carbon copy
+    #
+    # email         - The email of the recipient to be copied on the document
+    # name          - The name of the recipient
+    # signer_count  - Used to generate required attributes recipientId and routingOrder which must be unique in the document
+    #
+    def get_carbon_copies(options, signer_count)
+      copies = []
+        (options || []).each do |cc|
+          signer_count += 1
+          raise "Missing required data [:email, :name]" unless (cc[:email] && cc[:name])
+          cc.merge!(recipient_id: signer_count, routing_order: signer_count)
+          copies << camelize_keys(cc)
+        end
+      copies
+    end
+
+    # Public: Translate ruby oriented keys to camel cased keys recursively through the hash received
+    #
+    # The method expects symbol parameters in ruby form ":access_code" and translates them to camel cased "accessCode"
+    #
+    # example [{access_code: '12345', email_notification: {email_body: 'abcdef'}}] -> [{'accessCode': '12345', 'emailNotification': {'emailBody': 'abcdef'}}]
+    #
+    def camelize_keys(hash)
+      new_hash={}
+      hash.each do |k,v|
+        new_hash[camelize(k.to_s)] = (v.is_a?(Hash) ? camelize_keys(v) : v)
+      end
+      new_hash
+    end
+
+    # Generic implementation to avoid having to pull in Rails dependencies
+    #
+    def camelize(str)
+      str.gsub(/_([a-z])/) { $1.upcase }
+    end
+
+    # Internal: takes an array of hashes of certified deliveries
+    #
+    # email              - The recipient email
+    # name               - The recipient name
+    # recipient_id       - The recipient's id
+    # embedded           - Tells DocuSign if this is an embedded recipient which
+    #                      determines whether or not to deliver emails.
+    def get_certified_deliveries(certified_deliveries)
+      doc_certified_deliveries = []
+
+      certified_deliveries.each do |certified_delivery|
+        doc_certified_delivery = {
+          email:        certified_delivery[:email],
+          name:         certified_delivery[:name],
+          recipientId:  certified_delivery[:recipient_id]
+        }
+
+        if certified_delivery[:embedded]
+          doc_certified_delivery[:clientUserId] = certified_delivery[:client_id] || certified_delivery[:email]
+        end
+
+        doc_certified_deliveries << doc_certified_delivery
+      end
+      doc_certified_deliveries
+    end
+
     # TODO (2014-02-03) jonk => document
     def get_tabs(tabs, options, index)
       tab_array = []
@@ -412,6 +500,11 @@ module DocusignRest
         tab_hash[:width]      = tab[:width] if tab[:width]
         tab_hash[:height]     = tab[:height] if tab[:height]
         tab_hash[:value]      = tab[:value] if tab[:value]
+        tab_hash[:fontSize]   = tab[:font_size] if tab[:font_size]
+        tab_hash[:fontColor]  = tab[:font_color] if tab[:font_color]
+        tab_hash[:bold]       = tab[:bold] if tab[:bold]
+        tab_hash[:italic]     = tab[:italic] if tab[:italic]
+        tab_hash[:underline]  = tab[:underline] if tab[:underline]
         tab_hash[:selected]   = tab[:selected] if tab[:selected]
 
         tab_hash[:locked]     = tab[:locked] || false
@@ -421,6 +514,9 @@ module DocusignRest
         tab_hash[:groupName] = tab[:group_name] if tab.key?(:group_name)
         tab_hash[:radios] = get_tabs(tab[:radios], options, index) if tab.key?(:radios)
 
+        tab_hash[:validationMessage] = tab[:validation_message] if tab[:validation_message]
+        tab_hash[:validationPattern] = tab[:validation_pattern] if tab[:validation_pattern]
+
         tab_array << tab_hash
       end
       tab_array
@@ -508,7 +604,6 @@ module DocusignRest
     # Returns an array of server template hashes
     def get_composite_template(server_template_ids, signers, files)
       composite_array = []
-      index = 0
       server_template_ids.each_with_index do |template_id, idx|
         server_template_hash = {
             sequence: (idx+1).to_s,
@@ -545,12 +640,14 @@ module DocusignRest
           recipientId: signer[:recipient_id],
           roleName: signer[:role_name],
           clientUserId: signer[:client_id] || signer[:email],
+          requireSignOnPaper: signer[:require_sign_on_paper] || false,
           tabs: {
             textTabs:     get_signer_tabs(signer[:text_tabs]),
             checkboxTabs: get_signer_tabs(signer[:checkbox_tabs]),
             numberTabs:   get_signer_tabs(signer[:number_tabs]),
             fullNameTabs: get_signer_tabs(signer[:fullname_tabs]),
-            dateTabs:     get_signer_tabs(signer[:date_tabs])
+            dateTabs:     get_signer_tabs(signer[:date_tabs]),
+            signHereTabs: get_sign_here_tabs(signer[:sign_here_tabs])
           }
         }
         signers_array << signers_hash
@@ -577,6 +674,9 @@ module DocusignRest
       # headers={} - The fully merged, final request headers
       # boundary   - Optional: you can give the request a custom boundary
       #
+
+      headers = headers.dup.merge(parts: {post_body: {'Content-Type' => 'application/json'}})
+
       request = Net::HTTP::Post::Multipart.new(
         uri.request_uri,
         { post_body: post_body }.merge(file_params),
@@ -603,19 +703,23 @@ module DocusignRest
     # file_name     - The name you want to give to the file you are uploading
     # content_type  - (for the request body) application/json is what DocuSign
     #                 is expecting
-    # email_subject - (Optional) short subject line for the email
-    # email_body    - (Optional) custom text that will be injected into the
+    # email[subject] - (Optional) short subject line for the email
+    # email[body]    - (Optional) custom text that will be injected into the
     #                 DocuSign generated email
     # signers       - A hash of users who should receive the document and need
     #                 to sign it. More info about the options available for
     #                 this method are documented above it's method definition.
+    # carbon_copies - An array of hashes that includes users names and email who
+    #                 should receive a copy of the document once it is complete.
     # status        - Options include: 'sent', 'created', 'voided' and determine
     #                 if the envelope is sent out immediately or stored for
     #                 sending at a later time
     # customFields  - (Optional) A hash of listCustomFields and textCustomFields.
     #                 Each contains an array of corresponding customField hashes.
     #                 For details, please see: http://bit.ly/1FnmRJx
-    # headers       - Allows a client to pass in some
+    # headers       - Allows a client to pass in some headers
+    # web_sign      - (Optional) If true, the signer is allowed to print the
+    #                 document and sign it on paper. False if not defined.
     #
     # Returns a JSON parsed response object containing:
     #   envelopeId     - The envelope's ID
@@ -626,16 +730,20 @@ module DocusignRest
       ios = create_file_ios(options[:files])
       file_params = create_file_params(ios)
 
-      post_body = {
+      post_hash = {
         emailBlurb:   "#{options[:email][:body] if options[:email]}",
         emailSubject: "#{options[:email][:subject] if options[:email]}",
         documents: get_documents(ios),
         recipients: {
-          signers: get_signers(options[:signers])
+          signers: get_signers(options[:signers]),
+          carbonCopies: get_carbon_copies(options[:carbon_copies],options[:signers].size)
         },
+        eventNotification: get_event_notification(options[:event_notification]),
         status: "#{options[:status]}",
         customFields: options[:custom_fields]
-      }.to_json
+      }
+      post_hash[:enableWetSign] = options[:wet_sign] if options.has_key? :web_sign
+      post_body = post_hash.to_json
 
       uri = build_uri("/accounts/#{acct_id}/envelopes")
 
@@ -646,10 +754,10 @@ module DocusignRest
                 )
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
-
     # Public: allows a template to be dynamically created with several options.
     #
     # files         - An array of hashes of file parameters which will be used
@@ -706,6 +814,7 @@ module DocusignRest
                 )
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -720,6 +829,7 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -755,9 +865,12 @@ module DocusignRest
         emailBlurb:         options[:email][:body],
         emailSubject:       options[:email][:subject],
         templateId:         options[:template_id],
+        enableWetSign:      options[:wet_sign],
+        brandId:            options[:brand_id],
         eventNotification:  get_event_notification(options[:event_notification]),
         templateRoles:      get_template_roles(options[:signers]),
-        customFields:       options[:custom_fields]
+        customFields:       options[:custom_fields],
+        allowReassign:      options[:allow_reassign]
       }.to_json
 
       uri = build_uri("/accounts/#{acct_id}/envelopes")
@@ -768,6 +881,7 @@ module DocusignRest
       request.body = post_body
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -782,10 +896,8 @@ module DocusignRest
     # email/body            - Sets the text in the email body
     # email/subject         - Sets the text in the email subject line
     # files                 - Sets documents to be used instead of inline or server templates
-    # template_roles        - See the get_template_roles method definition for a list
-    #                         of options to pass. Note: for consistency sake we call
-    #                         this 'signers' and not 'templateRoles' when we build up
-    #                         the request in client code.
+    # signers               - See get_template_roles/get_inline_signers for a list
+    #                         of options to pass.
     # headers               - Optional hash of headers to merge into the existing
     #                         required headers for a multipart request.
     # server_template_ids   - Array of ids for templates uploaded to DocuSign. Templates
@@ -808,6 +920,8 @@ module DocusignRest
         emailBlurb:        "#{options[:email][:body] if options[:email]}",
         emailSubject:      "#{options[:email][:subject] if options[:email]}",
         status:             options[:status],
+        brandId:            options[:brand_id],
+        allowReassign:      options[:allow_reassign],
         compositeTemplates: get_composite_template(options[:server_template_ids], options[:signers], options[:files])
       }.to_json
 
@@ -820,6 +934,7 @@ module DocusignRest
                 )
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -842,9 +957,40 @@ module DocusignRest
       request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
+    # Public adds the certified delivery recipients (Need to View) for a given envelope
+    #
+    # envelope_id           - ID of the envelope for which you want to retrieve the
+    #                         signer info
+    # headers               - optional hash of headers to merge into the existing
+    #                         required headers for a multipart request.
+    # certified_deliveries  - A required hash of all the certified delivery recipients
+    #                         that need to be added to the envelope
+    #
+    # # The response returns the success or failure of each recipient being added
+    # to the envelope and the envelope ID
+    def add_envelope_certified_deliveries(options={})
+      content_type = { 'Content-Type' => 'application/json' }
+      content_type.merge(options[:headers]) if options[:headers]
+
+      post_body = {
+        certifiedDeliveries: get_certified_deliveries(options[:certified_deliveries]),
+      }.to_json
+
+      uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/recipients")
+
+      http = initialize_net_http_ssl(uri)
+
+      request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
+      request.body = post_body
+
+      response = http.request(request)
+      generate(request, response, uri)
+      JSON.parse(response.body)
+    end
 
     # Public returns the URL for embedded signing
     #
@@ -877,6 +1023,7 @@ module DocusignRest
       request.body = post_body
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -901,6 +1048,7 @@ module DocusignRest
       request.body = { returnUrl: options[:return_url] }.to_json
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -927,7 +1075,7 @@ module DocusignRest
       request.body = post_body
 
       response = http.request(request)
-
+      generate_log(request, response, uri)
       parsed_response = JSON.parse(response.body)
       parsed_response['url']
     end
@@ -955,6 +1103,7 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -971,6 +1120,7 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -985,6 +1135,8 @@ module DocusignRest
     # from_to_status - The status of the envelope checked for in the from_date - to_date period.
     #                  Defaults to 'changed'
     #
+    # envelope_ids   - Comma joined list of envelope_ids which you want to query.
+    #
     # status         - The current status of the envelope. Defaults to any status.
     #
     # Returns an array of hashes containing envelope statuses, ids, and similar information.
@@ -992,13 +1144,14 @@ module DocusignRest
       content_type = { 'Content-Type' => 'application/json' }
       content_type.merge(options[:headers]) if options[:headers]
 
-      query_params = options.slice(:from_date, :to_date, :from_to_status, :status)
+      query_params = options.slice(:from_date, :to_date, :from_to_status, :envelope_ids, :status)
+      # Note that Hash#to_query is an ActiveSupport monkeypatch
       uri = build_uri("/accounts/#{acct_id}/envelopes?#{query_params.to_query}")
 
       http     = initialize_net_http_ssl(uri)
       request  = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
-
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -1031,6 +1184,7 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
+      generate_log(request, response, uri)
       return response.body if options[:return_stream]
 
       split_path = options[:local_save_path].split('/')
@@ -1058,7 +1212,7 @@ module DocusignRest
       http     = initialize_net_http_ssl(uri)
       request  = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
-
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -1071,6 +1225,7 @@ module DocusignRest
     #                    filename itself
     # headers          - Optional hash of headers to merge into the existing
     #                    required headers for a multipart request.
+    # params           - Optional params; for example, certificate: true
     #
     # Example
     #
@@ -1086,10 +1241,12 @@ module DocusignRest
       content_type.merge(options[:headers]) if options[:headers]
 
       uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/documents/combined")
+      uri.query = URI.encode_www_form(options[:params]) if options[:params]
 
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
+      generate_log(request, response, uri)
       return response.body if options[:return_stream]
 
       split_path = options[:local_save_path].split('/')
@@ -1132,7 +1289,7 @@ module DocusignRest
       request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
       request.body = post_body
       response = http.request(request)
-
+      generate_log(request, response, uri)
       response
     end
 
@@ -1156,7 +1313,7 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
-
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -1170,6 +1327,7 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -1211,6 +1369,7 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -1228,6 +1387,7 @@ module DocusignRest
       request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
       request.body = post_body
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -1255,6 +1415,7 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Delete.new(uri.request_uri, headers(content_type))
       response = http.request(request)
+      generate_log(request, response, uri)
       json = response.body
       json = '{}' if json.nil? || json == ''
       JSON.parse(json)
@@ -1273,7 +1434,9 @@ module DocusignRest
 
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers({ 'Content-Type' => 'application/json' }))
-      JSON.parse(http.request(request).body)
+      response = http.request(request)
+      generate_log(request, response, uri)
+      JSON.parse(response.body)
     end
 
 
@@ -1287,7 +1450,9 @@ module DocusignRest
 
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers({ 'Content-Type' => 'application/json' }))
-      JSON.parse(http.request(request).body)
+      response = http.request(request)
+      generate_log(request, response, uri)
+      JSON.parse(response.body)
     end
 
 
@@ -1303,6 +1468,7 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -1329,6 +1495,7 @@ module DocusignRest
       request.body = post_body
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
@@ -1353,11 +1520,13 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
       request.body = post_body
-      http.request(request)
+      response = http.request(request)
+      generate_log(request, response, uri)
+      response
     end
 
     # Public deletes a document for a given envelope
-    # See https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST API References/Remove Documents from a Draft Envelope.htm%3FTocPath%3DREST%2520API%2520References%7C_____54
+    # See https://docs.docusign.com/esign/restapi/Envelopes/EnvelopeDocuments/delete/
     #
     # envelope_id  - ID of the envelope from which the doc will be retrieved
     # document_id - ID of the document to delete
@@ -1382,11 +1551,12 @@ module DocusignRest
       request.body = post_body
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
     # Public adds a document to a given envelope
-    # See https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST API References/Add Document.htm%3FTocPath%3DREST%2520API%2520References%7C_____56
+    # See https://docs.docusign.com/esign/restapi/Envelopes/EnvelopeDocuments/update/
     #
     # envelope_id  - ID of the envelope from which the doc will be added
     # document_id - ID of the document to add
@@ -1412,20 +1582,21 @@ module DocusignRest
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Put.new(uri.request_uri, headers(headers))
       request.body = post_body
-
-      http.request(request)
+      response = http.request(request)
+      generate_log(request, response, uri)
+      response
     end
 
     # Public adds signers to a given envelope
-    # See https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST%20API%20References/Add%20Recipients%20to%20an%20Envelope.htm%3FTocPath%3DREST%2520API%2520References|_____77
+    # Seehttps://docs.docusign.com/esign/restapi/Envelopes/EnvelopeRecipients/update/
     #
     # envelope_id - ID of the envelope to which the recipient will be added
     # signers - Array of hashes
-    #           See https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST%20API%20References/Recipients/Signers%20Recipient.htm%3FTocPath%3DREST%2520API%2520References|Send%2520an%2520Envelope%2520or%2520Create%2520a%2520Draft%2520Envelope|Recipient%2520Parameters|_____7
+    #           See https://docs.docusign.com/esign/restapi/Envelopes/EnvelopeRecipients/update/#definitions
     #
     # TODO: This could be made more general as an add_envelope_recipient method
     # to handle recipient types other than Signer
-    # See: https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST%20API%20References/Recipient%20Parameter.htm%3FTocPath%3DREST%2520API%2520References|Send%2520an%2520Envelope%2520or%2520Create%2520a%2520Draft%2520Envelope|Recipient%2520Parameters|_____0
+    # See: https://docs.docusign.com/esign/restapi/Envelopes/EnvelopeRecipients/update/#examples
     def add_envelope_signers(options = {})
       content_type = { "Content-Type" => "application/json" }
       content_type.merge(options[:headers]) if options[:headers]
@@ -1438,11 +1609,12 @@ module DocusignRest
       request.body = post_body
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
 
     # Public adds recipient tabs to a given envelope
-    # See https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm#REST API References/Add Tabs for a Recipient.htm%3FTocPath%3DREST%2520API%2520References%7C_____86
+    # See https://docs.docusign.com/esign/restapi/Envelopes/EnvelopeRecipients/update/
     #
     # envelope_id  - ID of the envelope from which the doc will be added
     # recipient - ID of the recipient to add tabs to
@@ -1488,7 +1660,32 @@ module DocusignRest
       request.body = post_body
 
       response = http.request(request)
+      generate_log(request, response, uri)
       JSON.parse(response.body)
     end
+
+    private
+
+    # Private: Generates a standardized log of the request and response pair
+    # to and from DocuSign for logging and API Certification.
+    # and resulting list is set to the publicly accessible: @previous_call_log
+    # For example:
+    # envelope = connection.create_envelope_from_document(doc)
+    # connection.previous_call_log.each {|line| logger.debug line }
+    def generate_log(request, response, uri)
+      log = ['--DocuSign REQUEST--']
+      log << "#{request.method} #{uri.to_s}"
+      request.each_capitalized{ |k,v| log << "#{k}: #{v.gsub(/(?<="Password":")(.+?)(?=")/, '[FILTERED]')}" }
+      # Trims out the actual binary file to reduce log size
+      if request.body
+        request_body = request.body.gsub(/(?<=Content-Transfer-Encoding: binary).+?(?=-------------RubyMultipartPost)/m, "\n[BINARY BLOB]\n")
+        log << "Body: #{request_body}"
+      end
+      log << '--DocuSign RESPONSE--'
+      log << "HTTP/#{response.http_version} #{response.code} #{response.msg}"
+      response.each_capitalized{ |k,v| log << "#{k}: #{v}" }
+      log << "Body: #{response.body}"
+      @previous_call_log = log
+    end
   end
 end