docusign_rest 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ad67abd3cf8814f9a5f7eea665b58a5f016778a
-  data.tar.gz: 5a6b872e865673e973b134488ed4afb54010472d
+  metadata.gz: 00bf2b5a6cfc048ecc6b0d597a35a572f47d99ad
+  data.tar.gz: 1cf63dc00aba24cbb32dd6fcf3413e849dc471c0
 SHA512:
-  metadata.gz: 208f52a15a46334b0751201ef5f790251bd87aa402d72391e7704713b2888bc7068f308acda1ff18477fcc4a95f6821d39854fae16db484b0adb1cf5b23d1922
-  data.tar.gz: 5e6debc7712fe8b73f9737b4357c5d2b6b4cf79b67d337efa9862e911fcdb1286318d1348473dc54461022a0567c2e531fcf9930ed045e2151de5cd7d6d7907e
+  metadata.gz: 0bcfc024ec427a3316064a9d4f9acf2c16f53e1958fd7e6130090739e3a01f4adf457f6095cad3d9b81315dfcb3069c7194d7ea82d3f43887a420fc5dead59f4
+  data.tar.gz: c868fa3f68ac8c580a4133853b7ca86c4db3acaaaf4da563d72c98f7686e3193d5d8a54e21643e17f66ccbf2daa62babbb6d50ca4dda1f8afc8c4676c1895321

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v0.3.2 July 27 2017
+
+* Implement DocusignRest::Client#update_signing_group_users (Pramod Chavan)
+* Add support for signer id_check_information_input (Pramod Chavan)
+* Add support for signer phone authentication (Pramod Chavan)
+* Implement DocusignRest::Client#add_envelope_recipients (Pramod Chavan)
+* Implement DocusignRest::Client#update_envelope_recipients (Pramod Chavan)
+* Implement DocusignRest::Client#get_signing_groups (Pramod Chavan)
+* Implement DocusignRest::Client#delete_signing_groups (Pramod Chavan)
+* Implement DocusignRest::Client#create_signing_group (Lakshmi Narayana Chitturi)
+* Fix parameter name type in DocusignRest::Client#void_envelope (Ryan Wood)
+* Implement DocusignRest::Client#get_page_image (Tom Copeland)
+
 ## v0.3.1 May 16 2017
 
 ### Features:

data/README.md

@@ -344,6 +344,16 @@ client.get_document_from_envelope(
 )
 ```
 
+**Void an envelope**
+
+```ruby
+client = DocusignRest::Client.new
+client.void_envelope(
+  envelope_id: @envelope_response["envelopeId"],
+  voided_reason: 'Reason provided by the user'
+)
+```
+
 ## 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, instantiate the `DocusignRest::Utility` class and call the breakout_path method like this:

data/Rakefile

@@ -8,3 +8,5 @@ Rake::TestTask.new do |test|
   test.pattern = 'test/**/*_test.rb'
   test.verbose = true
 end
+
+task default: [:"test"]

data/docusign_rest.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('pry')
   gem.add_development_dependency('vcr')
   gem.add_development_dependency('webmock')
+  gem.add_development_dependency('safe_yaml')
 end

data/lib/docusign_rest/client.rb

@@ -330,24 +330,42 @@ module DocusignRest
 
       signers.each_with_index do |signer, index|
         doc_signer = {
-          email:                                 signer[:email],
-          name:                                  signer[:name],
           accessCode:                            '',
           addAccessCodeToEmail:                  false,
           customFields:                          signer[:custom_fields],
-          iDCheckConfigurationName:              nil,
-          iDCheckInformationInput:               nil,
+          idCheckConfigurationName:              signer[:id_check_configuration_name],
+          idCheckInformationInput:               nil,
           inheritEmailNotificationConfiguration: false,
-          note:                                  '',
+          note:                                  signer[:note],
           phoneAuthentication:                   nil,
           recipientAttachment:                   nil,
-          recipientId:                           "#{index + 1}",
-          requireIdLookup:                       false,
+          requireIdLookup:                       signer[:require_id_lookup],
           roleName:                              signer[:role_name],
           routingOrder:                          signer[:routing_order] || index + 1,
           socialAuthentications:                 nil
         }
 
+        recipient_id = signer[:recipient_id] || index + 1
+        doc_signer[:recipientId] = recipient_id
+        doc_signer[:clientUserId] = recipient_id if signer[:embedded_signing]
+
+        if signer[:id_check_information_input]
+          doc_signer[:idCheckInformationInput] =
+            get_id_check_information_input(signer[:id_check_information_input])
+        end
+
+        if signer[:phone_authentication]
+          doc_signer[:phoneAuthentication] =
+            get_phone_authentication(signer[:phone_authentication])
+        end
+
+        if signer[:signing_group_id]
+          doc_signer[:signingGroupId] = signer[:signing_group_id]
+        else
+          doc_signer[:email] = signer[:email]
+          doc_signer[:name] = signer[:name]
+        end
+
         if signer[:email_notification]
           doc_signer[:emailNotification] = signer[:email_notification]
         end
@@ -729,6 +747,12 @@ module DocusignRest
     def create_envelope_from_document(options={})
       ios = create_file_ios(options[:files])
       file_params = create_file_params(ios)
+      recipients = if options[:certified_deliveries].nil? || options[:certified_deliveries].empty?
+                     { signers: get_signers(options[:signers]) }
+                   else
+                     { certifiedDeliveries: get_signers(options[:certified_deliveries]) }
+                   end
+
 
       post_hash = {
         emailBlurb:   "#{options[:email][:body] if options[:email]}",
@@ -1159,6 +1183,27 @@ module DocusignRest
     end
 
 
+    # Public retrieves a png of a page of a document in an envelope
+    #
+    # envelope_id      - ID of the envelope from which the doc will be retrieved
+    # document_id      - ID of the document to retrieve
+    # page_number      - page number to retrieve
+    #
+    # Returns the png as a bytestream
+    def get_page_image(options={})
+      envelope_id = options[:envelope_id]
+      document_id = options[:document_id]
+      page_number = options[:page_number]
+
+      uri = build_uri("/accounts/#{acct_id}/envelopes/#{envelope_id}/documents/#{document_id}/pages/#{page_number}/page_image")
+
+      http     = initialize_net_http_ssl(uri)
+      request  = Net::HTTP::Get.new(uri.request_uri, headers)
+      response = http.request(request)
+      generate_log(request, response, uri)
+      response.body
+    end
+
     # Public retrieves the attached file from a given envelope
     #
     # envelope_id      - ID of the envelope from which the doc will be retrieved
@@ -1518,7 +1563,7 @@ module DocusignRest
           "voidedReason" => options[:voided_reason] || "No reason provided."
       }.to_json
 
-      uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:folder_id]}")
+      uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}")
 
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
@@ -1656,7 +1701,31 @@ module DocusignRest
       content_type.merge(options[:headers]) if options[:headers]
 
       uri = build_uri("/accounts/#{@acct_id}/envelopes/#{options[:envelope_id]}/recipients/#{options[:recipient_id]}/tabs")
-      post_body = options[:tabs].to_json
+      tabs = options[:tabs]
+      index = options[:recipient_id] -  1
+
+      post_body = {
+        approveTabs:          nil,
+        checkboxTabs:         nil,
+        companyTabs:          nil,
+        dateSignedTabs:       get_tabs(tabs[:date_signed_tabs], options, index),
+        dateTabs:             nil,
+        declineTabs:          nil,
+        emailTabs:            nil,
+        envelopeIdTabs:       nil,
+        fullNameTabs:         nil,
+        listTabs:             nil,
+        noteTabs:             nil,
+        numberTabs:           nil,
+        radioGroupTabs:       nil,
+        initialHereTabs:      get_tabs(tabs[:initial_here_tabs], options.merge!(initial_here_tab: true), index),
+        signHereTabs:         get_tabs(tabs[:sign_here_tabs], options.merge!(sign_here_tab: true), index),
+        signerAttachmentTabs: nil,
+        ssnTabs:              nil,
+        textTabs:             nil,
+        titleTabs:            nil,
+        zipTabs:              nil
+      }.to_json
 
       http = initialize_net_http_ssl(uri)
       request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
@@ -1667,6 +1736,169 @@ module DocusignRest
       JSON.parse(response.body)
     end
 
+    # Public method - Creates Signing group
+    # group_name: The display name for the signing group. This can be a maximum of 100 characters.
+    # users: An array of group members for the signing group. (see example below)
+    #        It is composed of two elements:
+    #        name – The name for the group member. This can be a maximum of 100 characters.
+    #        email – The email address for the group member. This can be a maximum of 100 characters.
+    # [
+    #   {name: 'test1', email: 'test1@ygrene.us'}
+    #   {name: 'test2', email: 'test2@ygrene.us'}
+    # ]
+    #
+    #
+    # The response returns a success or failure with any error messages.
+    # For successes DocuSign generates a signingGroupId for each group, which is included in the response.
+    # The response also includes information about when the group was created and modified,
+    # including the account user that created and modified the group.
+    def create_signing_group(options={})
+      content_type = { 'Content-Type' => 'application/json' }
+      content_type.merge(options[:headers]) if options[:headers]
+
+      group_users = []
+      if options[:users]
+        options[:users].each do |user|
+          group_users << {
+            userName: user[:name],
+            email: user[:email]
+          }
+        end
+      end
+
+      post_body = {
+          groups: [
+            {
+              groupName: options[:group_name],
+              groupType: 'sharedSigningGroup',
+              users: group_users
+            }
+          ]
+        }.to_json
+
+      uri = build_uri("/accounts/#{@acct_id}/signing_groups")
+
+      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)
+
+      JSON.parse(response.body)
+    end
+
+    # Public method - deletes a signing group
+    # See https://docs.docusign.com/esign/restapi/SigningGroups/SigningGroups/delete/
+    #
+    # signingGroupId - ID of the signing group to delete
+    #
+    # Returns the success or failure of each group being deleted. Failed operations on array elements will add the "errorDetails"
+    # structure containing an error code and message. If "errorDetails" is null, then
+    # the operation was successful for that item.
+    def delete_signing_groups(options={})
+      content_type = {'Content-Type' => 'application/json'}
+      content_type.merge!(options[:headers]) if options[:headers]
+
+      uri = build_uri("/accounts/#{@acct_id}/signing_groups")
+
+      groups = options[:groups]
+      groups.each{|h| h[:signingGroupId] = h.delete(:signing_group_id) if h.key?(:signing_group_id)}
+      post_body = {
+        groups: groups
+      }.to_json
+
+      http = initialize_net_http_ssl(uri)
+      request = Net::HTTP::Delete.new(uri.request_uri, headers(content_type))
+      request.body = post_body
+
+      response = http.request(request)
+      JSON.parse(response.body)
+    end
+
+    # Public method - updates signing group users
+    # See https://docs.docusign.com/esign/restapi/SigningGroups/SigningGroupUsers/update/
+    #
+    # signingGroupId - ID of the signing group to update
+    #
+    # Returns the success or failure of each user being updated. Failed operations on array elements will add the "errorDetails"
+    # structure containing an error code and message. If "errorDetails" is null, then
+    # the operation was successful for that item.
+    def update_signing_group_users(options={})
+      content_type = {'Content-Type' => 'application/json'}
+      content_type.merge!(options[:headers]) if options[:headers]
+
+      uri = build_uri("/accounts/#{@acct_id}/signing_groups/#{options[:signing_group_id]}/users")
+
+      users = options[:users]
+      users.each do |user|
+       user[:userName] = user.delete(:user_name) if user.key?(:user_name)
+      end
+      post_body = {
+        users: users
+      }.to_json
+
+      http = initialize_net_http_ssl(uri)
+      request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
+      request.body = post_body
+
+      response = http.request(request)
+      JSON.parse(response.body)
+    end
+
+    # Public: Retrieves a list of available signing groups
+    def get_signing_groups
+      uri = build_uri("/accounts/#{@acct_id}/signing_groups")
+
+      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)
+    end
+
+    # Public: Update envelope recipients
+    def update_envelope_recipients(options={})
+      content_type = {'Content-Type' => 'application/json'}
+      content_type.merge(options[:headers]) if options[:headers]
+
+      resend = options[:resend].present?
+      uri = build_uri("/accounts/#{@acct_id}/envelopes/#{options[:envelope_id]}/recipients?resend_envelope=#{resend}")
+
+      signers = options[:signers]
+      signers.each do |signer|
+       signer[:recipientId] = signer.delete(:recipient_id) if signer.key?(:recipient_id)
+       signer[:clientUserId] = signer.delete(:client_user_id) if signer.key?(:client_user_id)
+      end
+      post_body = {
+        signers: signers
+      }.to_json
+
+      http = initialize_net_http_ssl(uri)
+      request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
+      request.body = post_body
+
+      response = http.request(request)
+      JSON.parse(response.body)
+    end
+
+    # Public: Add recipients to envelope
+    def add_envelope_recipients(options={})
+      content_type = {'Content-Type' => 'application/json'}
+      content_type.merge(options[:headers]) if options[:headers]
+
+      uri = build_uri("/accounts/#{@acct_id}/envelopes/#{options[:envelope_id]}/recipients?resend_envelope=true")
+
+      post_body = {
+        signers: get_signers(options[:signers])
+      }.to_json
+
+      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)
+      JSON.parse(response.body)
+    end
+
     private
 
     # Private: Generates a standardized log of the request and response pair
@@ -1690,5 +1922,57 @@ module DocusignRest
       log << "Body: #{response.body}"
       @previous_call_log = log
     end
+
+    def get_id_check_information_input(input)
+      {
+        addressInformationInput: get_address_information_input(
+          input.dig(:address_information_input, :address_information)),
+        ssn4InformationInput: get_ssn4_information_input(input[:ssn4_information_input]),
+        dobInformationInput: get_dob_information_input(input[:dob_information_input])
+      }
+    end
+
+    def get_address_information_input(input)
+      return {} unless input
+      {
+        addressInformation:{
+          street1: input[:street1],
+          city: input[:city],
+          state: input[:state],
+          zip: input[:zip],
+          zipPlus4: input[:zip_plus4],
+        },
+        displayLevelCode: 'DoNotDisplay',
+        receiveInResponse: true,
+      }
+    end
+
+    def get_phone_authentication(input)
+      return {} unless input
+      {
+        recipMayProvideNumber: true,
+        validateRecipProvidedNumber: true,
+        recordVoicePrint: true,
+        senderProvidedNumbers: input[:sender_provided_numbers],
+      }
+    end
+
+    def get_ssn4_information_input(input)
+      return {} unless input
+      {
+        ssn4: input[:ssn4],
+        displayLevelCode: 'DoNotDisplay',
+        receiveInResponse: true,
+      }
+    end
+
+    def get_dob_information_input(input)
+      return {} unless input
+      {
+        dateOfBirth: input[:date_of_birth],
+        displayLevelCode: 'DoNotDisplay',
+        receiveInResponse: true,
+      }
+    end
   end
 end

data/lib/docusign_rest/version.rb

@@ -1,3 +1,3 @@
 module DocusignRest
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docusign_rest
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Jon Kinney
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -151,6 +151,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Hooks a Rails app up to the DocuSign service through the DocuSign REST
   API
 email: