echosign 1.0.2 → 1.5.0

data/fixtures/vcr_cassettes/get_widget.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://secure.echosign.com/api/rest/v5/widgets/2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*
+    uri: https://api.eu1.echosign.com/api/rest/v5/widgets/2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/vcr_cassettes/get_widget_document_file.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://secure.echosign.com/api/rest/v5/widgets/2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*/documents/2AAABLblqZhCGyGn1bpbXp-Kt-QXX8fsBWhjjO-bUKd0NQ184Xxm-mE6gg0DN0e-3k0Lwj6IPw9Q*
+    uri: https://api.eu1.echosign.com/api/rest/v5/widgets/2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*/documents/2AAABLblqZhCGyGn1bpbXp-Kt-QXX8fsBWhjjO-bUKd0NQ184Xxm-mE6gg0DN0e-3k0Lwj6IPw9Q*
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/vcr_cassettes/get_widget_documents.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://secure.echosign.com/api/rest/v5/widgets/2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*/documents
+    uri: https://api.eu1.echosign.com/api/rest/v5/widgets/2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*/documents
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/vcr_cassettes/get_widgets.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://secure.echosign.com/api/rest/v5/widgets
+    uri: https://api.eu1.echosign.com/api/rest/v5/widgets
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/vcr_cassettes/library_combined_document.yml

@@ -2,10 +2,10 @@
 http_interactions:
 - request:
     method: get
-    uri: https://secure.echosign.com/api/rest/v5/libraryDocuments/2AAABLblqZhAlC4t0c3xAJ92RFv44xFGZhbCuHpalUdpcHW9k72imMEG-W1SYCmUoia1ZNgQZ-FE*/combinedDocument?auditReport=true
+    uri: https://api.eu1.echosign.com/api/rest/v5/libraryDocuments/2AAABLblqZhAlC4t0c3xAJ92RFv44xFGZhbCuHpalUdpcHW9k72imMEG-W1SYCmUoia1ZNgQZ-FE*/combinedDocument
     body:
       encoding: US-ASCII
-      string: ''
+      string: 'auditReport=true'
     headers:
       Accept:
       - '*/*; q=0.5, application/xml'

data/fixtures/vcr_cassettes/library_document_audit_trail.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://secure.echosign.com/api/rest/v5/libraryDocuments/2AAABLblqZhAlC4t0c3xAJ92RFv44xFGZhbCuHpalUdpcHW9k72imMEG-W1SYCmUoia1ZNgQZ-FE*/auditTrail
+    uri: https://api.eu1.echosign.com/api/rest/v5/libraryDocuments/2AAABLblqZhAlC4t0c3xAJ92RFv44xFGZhbCuHpalUdpcHW9k72imMEG-W1SYCmUoia1ZNgQZ-FE*/auditTrail
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/vcr_cassettes/personalize_widget.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: put
-    uri: https://secure.echosign.com/api/rest/v5/widgets/2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*/personalize
+    uri: https://api.eu1.echosign.com/api/rest/v5/widgets/2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*/personalize
     body:
       encoding: UTF-8
       string: '{"email":"cthomas@railjumper.com"}'

data/fixtures/vcr_cassettes/refresh_token.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://secure.echosign.com/oauth/refresh
+    body:
+      encoding: UTF-8
+      string: client_id=9Q444442AX82M&client_secret=390db09fc6672388b9457593a7&grant_type=refresh_token&refresh_token=3AAABLblqZhCNb-X2YXthBgBsEVpM1xC0EATrsDEo0yAmXOIlM58tuASRzYaMjhUGNbRQga8syqE%2A
+    headers:
+      User-Agent:
+      - Faraday v0.12.2
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 11 Sep 2018 23:41:11 GMT
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000;
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Robots-Tag:
+      - none
+      P3p:
+      - CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json;charset=UTF-8
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"3AAABLblqZhA9xhGH0gLPM8cKzF-pe_Uv_0_w72y8CqySA1kyRLveqY7fWZo_M3GC9u-ogYb3eAnD95YpnnlerKigV6IZHqFZ","token_type":"Bearer","expires_in":3600}'
+    http_version: 
+  recorded_at: Tue, 11 Sep 2018 23:41:11 GMT
+recorded_with: VCR 2.8.0

data/fixtures/vcr_cassettes/revoke_token.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://secure.echosign.com/oauth/revoke
+    body:
+      encoding: UTF-8
+      string: token=3AAABLblqZhAN-cxVlpFIUv3XdlgqlyWF8qVbIWnUmmvkAB4u6yPBE50XAqTqzLNCjbWS8QKAZPdgYOaqZHv6EE5LEJOc5NOK
+    headers:
+      User-Agent:
+      - Faraday v0.12.2
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 12 Sep 2018 00:53:24 GMT
+      Server:
+      - Apache
+      Content-Length:
+      - '0'
+      Strict-Transport-Security:
+      - max-age=31536000;
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Robots-Tag:
+      - none
+      P3p:
+      - CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Wed, 12 Sep 2018 00:53:24 GMT
+recorded_with: VCR 2.8.0

data/fixtures/vcr_cassettes/update_widget_status.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: put
-    uri: https://secure.echosign.com/api/rest/v5/widgets/2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*/status
+    uri: https://api.eu1.echosign.com/api/rest/v5/widgets/2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*/status
     body:
       encoding: UTF-8
       string: '{"value":"DISABLE","message":"Hey guys, hope you like this widget."}'

data/lib/echosign.rb

@@ -1,11 +1,11 @@
-require 'json'
-require "echosign/version"
-require 'echosign/client'
-require 'echosign/validatable'
-require 'echosign/credentials'
-require 'echosign/refresh'
-require 'echosign/request'
-require 'echosign/agreement'
-require 'echosign/user'
-require 'echosign/reminder'
-require 'echosign/widget'
+require 'json'
+require "echosign/version"
+require 'echosign/client'
+require 'echosign/validatable'
+require 'echosign/credentials'
+require 'echosign/refresh'
+require 'echosign/request'
+require 'echosign/agreement'
+require 'echosign/user'
+require 'echosign/reminder'
+require 'echosign/widget'

data/lib/echosign/agreement.rb

@@ -6,7 +6,6 @@ require 'echosign/agreement/form_field_location'
 
 module Echosign
   class Agreement < Hash
-
     include Validatable
 
     attr_accessor :user_id, :user_email
@@ -16,19 +15,36 @@ module Echosign
     # @param [String] user_id ID of the user whom this agreement is made for
     # @param [String] user_email Email of the user whom this agreement is made for
     # @param [Hash] params SYMBOL-referenced Hash containing:
-    # @option params [Array] :fileInfos A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified.  Populate the array with instances of {Echosign::Fileinfo Echosign::Fileinfo} (REQUIRED)
-    # @option params [Array] :recipientSetInfos A list of one or more recipients. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document. This limit includes the sender if the sender's signature is also required.  Populate the array with instances of {Echosign::Recipient Echosign::Recipient} (REQUIRED)
-    # @option params [String] :signatureFlow ['SENDER_SIGNATURE_NOT_REQUIRED' or 'SENDER_SIGNS_LAST' or 'SENDER_SIGNS_FIRST' or 'SEQUENTIAL' or 'PARALLEL']: Selects the workflow you would like to use - whether the sender needs to sign before the recipient, after the recipient, or not at all. The possible values for this variable are SENDER_SIGNATURE_NOT_REQUIRED, SENDER_SIGNS_LAST, SENDER_SIGNS_FIRST, SEQUENTIAL or PARALLEL.  (REQUIRED)
-    # @option params [String] :signatureType ['ESIGN' or 'WRITTEN']: Specifies the type of signature you would like to request - written or eSignature. The possible values are ESIGN or WRITTEN  (REQUIRED)
-    # @option params [String] :name The name of the agreement that will be used to identify it, in emails and on the website. (REQUIRED)
-    # @return [Echosign::Agreement] 
-    def initialize(user_id=nil, user_email=nil, params)
+    # @option params [Array] :fileInfos A list of one or more files (or references to files) that will be sent out
+    #   for signature. If more than one file is provided, they will be combined into one PDF before being sent out.
+    #   Note: Only one of the four parameters in every FileInfo object must be specified.  Populate the array with
+    #   instances of {Echosign::Fileinfo Echosign::Fileinfo} (REQUIRED)
+    # @option params [Array] :recipientSetInfos A list of one or more recipients. For regular (non-MegaSign)
+    #   documents, there is no limit on the number of electronic signatures in a single document. Written signatures
+    #   are limited to four per document. This limit includes the sender if the sender's signature is also required.
+    #    Populate the array with instances of {Echosign::Recipient Echosign::Recipient} (REQUIRED)
+    # @option params [String] :signatureFlow ['SENDER_SIGNATURE_NOT_REQUIRED' or 'SENDER_SIGNS_LAST' or
+    #   'SENDER_SIGNS_FIRST' or 'SEQUENTIAL' or 'PARALLEL']: Selects the workflow you would like to use - whether
+    #   the sender needs to sign before the recipient, after the recipient, or not at all. The possible values for
+    #   this variable are SENDER_SIGNATURE_NOT_REQUIRED, SENDER_SIGNS_LAST, SENDER_SIGNS_FIRST, SEQUENTIAL or
+    #   PARALLEL.  (REQUIRED)
+    # @option params [String] :signatureType ['ESIGN' or 'WRITTEN']: Specifies the type of signature you would like
+    #   to request - written or eSignature. The possible values are ESIGN or WRITTEN  (REQUIRED)
+    # @option params [String] :name The name of the agreement that will be used to identify it, in emails and on the
+    #   website. (REQUIRED)
+    # @return [Echosign::Agreement]
+    def initialize(user_id = nil, user_email = nil, params)
       @user_id = user_id
       @user_email = user_email
-      #TODO (cthomas) barf if user_id or user_email are blank
+      # TODO (cthomas) barf if user_id or user_email are blank
+      if params.has_key?(:recipients)
+        warn("NOTE: :recipients param in #{self.class}.new is deprecated; use :recipientSetInfos instead.\n" +
+             "#{self.class}.new called from #{Gem.location_of_caller.join(":")}")
+        params = params.dup
+        params[:recipientSetInfos] ||= params.delete :recipients
+      end
       require_keys([:signatureType, :recipientSetInfos, :signatureFlow, :fileInfos, :name], params)
       merge!({ documentCreationInfo: params })
     end
-
   end # class Agreement
 end # module Echosign

data/lib/echosign/agreement/client.rb

@@ -1,118 +1,125 @@
 module Echosign
-
   class Client
+    # Creates an agreement
+    #
+    # @param agreement [Echosign::Agreement]
+    # @return [String] Agreement ID
+    def create_agreement(agreement)
+      agreement_response = request(:create_agreement, agreement, agreement.user_id, agreement.user_email)
+      return agreement_response['agreementId'] if agreement_response.has_key?('agreementId')
 
-   # Creates an agreement
-   #
-   # @param agreement [Echosign::Agreement]
-   # @return [String] Agreement ID
-   def create_agreement(agreement)
-      agreement_response = Echosign::Request.create_agreement(agreement, token, agreement.user_id, agreement.user_email)
-      agreement_response.fetch("agreementId")
-   end
-
-   # Gets list of agreements
-   #
-   # @param agreement [Echosign::Agreement]
-   # @return [String] Agreement ID
-   def get_agreements
-     get_agreements_response = Echosign::Request.get_agreements(token)
-     get_agreements_response.fetch("userAgreementList")
-   end
+      raise "Error creating agreement - response was #{agreement_response}"
+    end
 
-   # Gets detailed info on an agreement
-   # 
-   # @param agreement_id [String] ID of agreement to retrieve info on.
-   # @return [Hash] Detailed agreement info
-   def agreement_info(agreement_id)
-     Echosign::Request.agreement_info(token, agreement_id)
-   end
+    # Gets list of agreements
+    #
+    # @return [Hash] An array of user agreement items
+    def get_agreements
+      get_agreements_response = request(:get_agreements)
+      get_agreements_response.fetch("userAgreementList")
+    end
 
-   # Cancel agreement
-   # 
-   # @param agreement_id [String] (REQUIRED)
-   # @param notify_signer [Boolean] Whether to notify the signer by email of the cancellation.  Default is false.
-   # @param comment [String] Comment regarding this cancellation.
-   # @return [String] Result of the operation
-   def cancel_agreement(agreement_id, notify_signer=false, comment=nil)
-     request_body = {
-       "value" => "CANCEL",
-       "notifySigner" => notify_signer 
-     }
-     request_body.merge!(comment: comment) unless comment.nil?
+    # Gets detailed info on an agreement
+    #
+    # @param agreement_id [String] ID of agreement to retrieve info on.
+    # @return [Hash] Detailed agreement info
+    def agreement_info(agreement_id)
+      request(:agreement_info, agreement_id)
+    end
 
-     agreement_status_response = Echosign::Request.update_agreement_status(token, agreement_id, request_body)
-     agreement_status_response.fetch('result')
-   end
+    # Cancel agreement
+    #
+    # @param agreement_id [String] (REQUIRED)
+    # @param notify_signer [Boolean] Whether to notify the signer by email of the cancellation.  Default is false.
+    # @param comment [String] Comment regarding this cancellation.
+    # @return [String] Result of the operation
+    def cancel_agreement(agreement_id, notify_signer = false, comment = nil)
+      request_body = {
+        "value" => "CANCEL",
+        "notifySigner" => notify_signer
+      }
+      request_body[:comment] = comment unless comment.nil?
 
-   # All documents relating to an agreement
-   # 
-   # @param agreement_id [String] (REQUIRED)
-   # @param recipient_email [String] The email address of the participant to be used to retrieve documents. (REQUIRED)
-   # @param format [String] Content format of the supported documents. It can have two possible values ORIGINAL or CONVERTED_PDF. (REQUIRED)
-   # @param version_id [String] Version of the agreement as provided by agreement_info().  If not provided, the latest version of the agreement is used.
-   # @return [Array] Documents relating to agreement.
-   def agreement_documents(agreement_id, recipient_email, format, version_id=nil)
-     result = Echosign::Request.agreement_documents(token, agreement_id, recipient_email, format, version_id)
-   end
+      agreement_status_response = request(:update_agreement_status, agreement_id, request_body)
+      agreement_status_response.fetch('result')
+    end
 
-   # Retrieve a document file from an agreement
-   #
-   # @param agreement_id [String]  (REQUIRED)
-   # @param document_id [String]  (REQUIRED)
-   # @param file_path [String] File path to save the document.  If no file path is given, nothing is saved to disk.
-   # @return [String] Raw bytes from document file
-   def agreement_document_file(agreement_id, document_id, file_path=nil)
-     response = Echosign::Request.agreement_document_file(token, agreement_id, document_id)
-     unless file_path.nil?
-       file = File.new(file_path, 'wb')
-       file.write(response)
-       file.close
-     end
-     response
-   end
+    # All documents relating to an agreement
+    #
+    # @param agreement_id [String] (REQUIRED)
+    # @param recipient_email [String] The email address of the participant to be used to retrieve documents. (REQUIRED)
+    # @param format [String] Content format of the supported documents. It can have two possible values ORIGINAL or
+    #   CONVERTED_PDF. (REQUIRED)
+    # @param version_id [String] Version of the agreement as provided by agreement_info().  If not provided, the
+    #   latest version of the agreement is used.
+    # @return [Array] Documents relating to agreement.
+    def agreement_documents(agreement_id, recipient_email, format, version_id = nil)
+      result = request(:agreement_documents, agreement_id, recipient_email, format, version_id)
+    end
 
-   # Retrieves the URL for the eSign page for the current signer(s) of an agreement
-   #
-   # @param agreement_id [String]  (REQUIRED)
-   # @return [Hash] URL information for the eSign page of the agreement
-   def agreement_signing_urls(agreement_id)
-     response = Echosign::Request.agreement_signing_urls(token, agreement_id)
-   end
+    # Retrieve a document file from an agreement
+    #
+    # @param agreement_id [String]  (REQUIRED)
+    # @param document_id [String]  (REQUIRED)
+    # @param file_path [String] File path to save the document.  If no file path is given, nothing is saved to disk.
+    # @return [String] Raw bytes from document file
+    def agreement_document_file(agreement_id, document_id, file_path = nil)
+      response = request(:agreement_document_file, agreement_id, document_id)
+      unless file_path.nil?
+        file = File.new(file_path, 'wb')
+        file.write(response)
+        file.close
+      end
+      response
+    end
 
-   # Gets a single combined PDF document for the documents associated with an agreement.
-   # 
-   # @param agreement_id [String]  (REQUIRED)
-   # @param file_path [String] File path to save the document.  If no file path is given, nothing is saved to disk.
-   # @param versionId [String] The version identifier of agreement as provided by get_agreement. If not provided then latest version will be used
-   # @param participantEmail [String] The email address of the participant to be used to retrieve documents.  If none is given, the auth token will be used to determine the user
-   # @param attachSupportingDocuments [Boolean] When set to YES, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true.
-   # @param auditReport [Boolean] When set to YES, attach an audit report to the signed agreement PDF. Default value is false
-   # @return [String] Raw bytes from document file
-   def agreement_combined_pdf(agreement_id, file_path=nil, versionId=nil, participantEmail=nil, attachSupportingDocuments=true, auditReport=false)
-     response = Echosign::Request.agreement_combined_pdf(token, agreement_id, versionId, participantEmail, attachSupportingDocuments, auditReport)
-     unless file_path.nil?
-       file = File.new(file_path, 'wb')
-       file.write(response)
-       file.close
-     end
-     response
-   end
+    # Retrieves the URL for the eSign page for the current signer(s) of an agreement
+    #
+    # @param agreement_id [String]  (REQUIRED)
+    # @return [Hash] URL information for the eSign page of the agreement
+    def agreement_signing_urls(agreement_id)
+      response = request(:agreement_signing_urls, agreement_id)
+    end
 
-   # Retrieves library document audit trail file
-   # 
-   # @param agreement_id [String]  (REQUIRED)
-   # @param file_path [String] File path where to save the CSV file.  If no file path is given, nothing is saved to disk.
-   # @return [String] Raw bytes representing CSV file
-   def agreement_form_data(agreement_id, file_path=nil)
-     response = Echosign::Request.agreement_form_data(token, agreement_id)
-     unless file_path.nil?
-       file = File.new(file_path, 'wb')
-       file.write(response)
-       file.close
-     end
-     response
-   end
+    # Gets a single combined PDF document for the documents associated with an agreement.
+    #
+    # @param agreement_id [String]  (REQUIRED)
+    # @param file_path [String] File path to save the document.  If no file path is given, nothing is saved to disk.
+    # @param versionId [String] The version identifier of agreement as provided by get_agreement. If not provided
+    #   then latest version will be used
+    # @param participantEmail [String] The email address of the participant to be used to retrieve documents.  If
+    #   none is given, the auth token will be used to determine the user
+    # @param attachSupportingDocuments [Boolean] When set to YES, attach corresponding supporting documents to the
+    #   signed agreement PDF. Default value of this parameter is true.
+    # @param auditReport [Boolean] When set to YES, attach an audit report to the signed agreement PDF. Default
+    #   value is false
+    # @return [String] Raw bytes from document file
+    def agreement_combined_pdf(agreement_id, file_path = nil, versionId = nil, participantEmail = nil,
+                               attachSupportingDocuments = true, auditReport = false)
+      response = request(:agreement_combined_pdf, agreement_id, versionId, participantEmail, attachSupportingDocuments,
+                         auditReport)
+      unless file_path.nil?
+        file = File.new(file_path, 'wb')
+        file.write(response)
+        file.close
+      end
+      response
+    end
 
+    # Retrieves library document audit trail file
+    #
+    # @param agreement_id [String]  (REQUIRED)
+    # @param file_path [String] File path where to save the CSV file.  If no file path is given, nothing is saved to
+    #   disk.
+    # @return [String] Raw bytes representing CSV file
+    def agreement_form_data(agreement_id, file_path = nil)
+      response = request(:agreement_form_data, agreement_id)
+      unless file_path.nil?
+        file = File.new(file_path, 'wb')
+        file.write(response)
+        file.close
+      end
+      response
+    end
   end
 end