echosign 1.0.2 → 1.5.0

data/lib/echosign/library_documents/client.rb

@@ -1,22 +1,22 @@
 module Echosign
-
-  class Client 
-
+  class Client
     # Retrieves library documents metadata for a user.
     #
-    # @param user_id [String] The ID of the user whose library documents are being requested. 
-    # @param user_email [String] The email address of the user whose library documents are being requested. If both user_id and user_email are provided then user_id is given preference. If neither is specified then the user is inferred from the access token.
+    # @param user_id [String] The ID of the user whose library documents are being requested.
+    # @param user_email [String] The email address of the user whose library documents are being requested. If both
+    #   user_id and user_email are provided then user_id is given preference. If neither is specified then the user
+    #   is inferred from the access token.
     # @return [Hash] Library documents metadata
-    def get_library_documents(user_id=nil, user_email=nil)
-      Echosign::Request.get_library_documents(token, user_id, user_email)
+    def get_library_documents(user_id = nil, user_email = nil)
+      request(:get_library_documents, user_id, user_email)
     end
 
-    # Retrieves library document metadata 
+    # Retrieves library document metadata
     #
     # @param library_document_id [String] (REQUIRED)
     # @return [Hash] Library document metadata
     def get_library_document(library_document_id)
-      Echosign::Request.get_library_document(token, library_document_id)
+      request(:get_library_document, library_document_id)
     end
 
     # Retrieves library document files metadata
@@ -24,7 +24,7 @@ module Echosign
     # @param library_document_id [String] (REQUIRED)
     # @return [Hash] Library document files metadata
     def get_library_document_files(library_document_id)
-      Echosign::Request.get_library_document_files(token, library_document_id)
+      request(:get_library_document_files, library_document_id)
     end
 
     # Retrieves library document file data
@@ -33,8 +33,8 @@ module Echosign
     # @param file_id [String] (REQUIRED)
     # @param file_path [String] File path for saving the document.  If none is given, nothing will be saved to disk.
     # @return [String] Raw library document file data
-    def get_library_document_file(library_document_id, file_id, file_path=nil)
-      response = Echosign::Request.get_library_document_file(token, library_document_id, file_id)
+    def get_library_document_file(library_document_id, file_id, file_path = nil)
+      response = request(:get_library_document_file, library_document_id, file_id)
       unless file_path.nil?
         file = File.new(file_path, 'wb')
         file.write(response)
@@ -48,8 +48,8 @@ module Echosign
     # @param library_document_id (REQUIRED)
     # @param file_path [String] File path for saving the document.  If none is given, nothing will be saved to disk.
     # @return [String] Raw library document file data
-    def library_document_audit_trail(library_document_id, file_path=nil)
-      response = Echosign::Request.library_document_audit_trail(token, library_document_id)
+    def library_document_audit_trail(library_document_id, file_path = nil)
+      response = request(:library_document_audit_trail, library_document_id)
       unless file_path.nil?
         file = File.new(file_path, 'wb')
         file.write(response)
@@ -62,10 +62,11 @@ module Echosign
     #
     # @param library_document_id (REQUIRED)
     # @param file_path [String] File path for saving the document.  If none is given, nothing will be saved to disk.
-    # @param auditReport [Boolean] When set to YES attach an audit report to the library document PDF. Default value will be false.
+    # @param auditReport [Boolean] When set to YES attach an audit report to the library document PDF. Default value
+    #   will be false.
     # @return [String] Raw library combined document file data
-    def library_combined_document(library_document_id, file_path=nil, auditReport=false)
-      response = Echosign::Request.library_combined_document(token, library_document_id, auditReport)
+    def library_combined_document(library_document_id, file_path = nil, auditReport = false)
+      response = request(:library_combined_document, library_document_id, auditReport)
       unless file_path.nil?
         file = File.new(file_path, 'wb')
         file.write(response)
@@ -73,11 +74,5 @@ module Echosign
       end
       response
     end
-
-
-
-
   end
 end
-
-

data/lib/echosign/library_documents/request.rb

@@ -1,16 +1,17 @@
 module Echosign::Request
-
   # Retrieves library documents for a user.
   #
   # @param token [String] Auth Token
-  # @param user_id [String] The ID of the user whose library documents are being requested. 
-  # @param user_email [String] The email address of the user whose library documents are being requested. If both user_id and user_email are provided then user_id is given preference. If neither is specified then the user is inferred from the access token.
+  # @param user_id [String] The ID of the user whose library documents are being requested.
+  # @param user_email [String] The email address of the user whose library documents are being requested. If both
+  #   user_id and user_email are provided then user_id is given preference. If neither is specified then the user
+  #   is inferred from the access token.
   # @return [Hash] Library documents metadata
-  def self.get_library_documents(token, user_id=nil, user_email=nil)
+  def self.get_library_documents(token, base_uri, user_id = nil, user_email = nil)
     headers = { 'Access-Token' => token }
-    headers.merge!('X-User-Id' => user_id) unless user_id.nil?
-    headers.merge!('X-User-Email' => user_email) unless user_email.nil?
-    endpoint = ENDPOINT.fetch(:libraryDocument)
+    headers['X-User-Id'] = user_id unless user_id.nil?
+    headers['X-User-Email'] = user_email unless user_email.nil?
+    endpoint = ENDPOINT.fetch(:libraryDocument, base_uri)
     response = get(endpoint, headers)
     JSON.parse(response.body)
   end
@@ -20,9 +21,9 @@ module Echosign::Request
   # @param token [String] Auth Token
   # @param library_document_id [String]
   # @return [Hash] Library document metadata
-  def self.get_library_document(token, library_document_id)
+  def self.get_library_document(token, base_uri, library_document_id)
     headers = { 'Access-Token' => token }
-    endpoint = "#{ENDPOINT.fetch(:libraryDocument)}/#{library_document_id}"
+    endpoint = "#{ENDPOINT.fetch(:libraryDocument, base_uri)}/#{library_document_id}"
     response = get(endpoint, headers)
     JSON.parse(response.body)
   end
@@ -32,9 +33,9 @@ module Echosign::Request
   # @param token [String] Auth Token
   # @param library_document_id [String] (REQUIRED)
   # @return [Hash] Library document files metadata
-  def self.get_library_document_files(token, library_document_id)
+  def self.get_library_document_files(token, base_uri, library_document_id)
     headers = { 'Access-Token' => token }
-    endpoint = "#{ENDPOINT.fetch(:libraryDocument)}/#{library_document_id}/documents"
+    endpoint = "#{ENDPOINT.fetch(:libraryDocument, base_uri)}/#{library_document_id}/documents"
     response = get(endpoint, headers)
     JSON.parse(response.body)
   end
@@ -45,9 +46,9 @@ module Echosign::Request
   # @param library_document_id [String] (REQUIRED)
   # @param file_id [String] (REQUIRED)
   # @return [String] Library document file data
-  def self.get_library_document_file(token, library_document_id, file_id)
+  def self.get_library_document_file(token, base_uri, library_document_id, file_id)
     headers = { 'Access-Token' => token }
-    endpoint = "#{ENDPOINT.fetch(:libraryDocument)}/#{library_document_id}/documents/#{file_id}"
+    endpoint = "#{ENDPOINT.fetch(:libraryDocument, base_uri)}/#{library_document_id}/documents/#{file_id}"
     response = get(endpoint, headers)
   end
 
@@ -56,9 +57,9 @@ module Echosign::Request
   # @param token [String] Auth Token
   # @param library_document_id [String] (REQUIRED)
   # @return [String] Library document file data
-  def self.library_document_audit_trail(token, library_document_id)
+  def self.library_document_audit_trail(token, base_uri, library_document_id)
     headers = { 'Access-Token' => token }
-    endpoint = "#{ENDPOINT.fetch(:libraryDocument)}/#{library_document_id}/auditTrail"
+    endpoint = "#{ENDPOINT.fetch(:libraryDocument, base_uri)}/#{library_document_id}/auditTrail"
     response = get(endpoint, headers)
   end
 
@@ -67,12 +68,10 @@ module Echosign::Request
   # @param token [String] Auth Token
   # @param library_document_id [String] (REQUIRED)
   # @return [String] Raw library combined document file data
-  def self.library_combined_document(token, library_document_id, auditReport)
+  def self.library_combined_document(token, base_uri, library_document_id, auditReport)
     headers = { 'Access-Token' => token }
-    endpoint = "#{ENDPOINT.fetch(:libraryDocument)}/#{library_document_id}/combinedDocument"
-    endpoint << add_query(endpoint, "auditReport=#{auditReport}") 
+    endpoint = "#{ENDPOINT.fetch(:libraryDocument, base_uri)}/#{library_document_id}/combinedDocument"
+    endpoint << add_query(endpoint, "auditReport=#{auditReport}")
     response = get(endpoint, headers)
   end
-
 end
-

data/lib/echosign/mega_sign.rb

@@ -4,7 +4,6 @@ require 'echosign/agreement/recipient'
 
 module Echosign
   class MegaSign < Hash
-
     include Validatable
 
     attr_accessor :user_id, :user_email
@@ -14,19 +13,30 @@ module Echosign
     # @param [String] user_id ID of the user whom this megasign is made for
     # @param [String] user_email Email of the user whom this megasign 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 megasign that will be used to identify it, in emails and on the website. (REQUIRED)
-    # @return [Echosign::MegaSign] 
-    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 megasign that will be used to identify it, in emails and on the
+    #   website. (REQUIRED)
+    # @return [Echosign::MegaSign]
+    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
       require_keys([:signatureType, :recipientSetInfos, :signatureFlow, :fileInfos, :name], params)
       merge!({ megaSignCreationInfo: params })
     end
-
   end # class MegaSign
 end # module Echosign

data/lib/echosign/mega_sign/client.rb

@@ -1,119 +1,124 @@
 module Echosign
-
   class Client
-
-   # Creates an mega_sign
-   #
-   # @param mega_sign [Echosign::Agreement]
-   # @return [String] Agreement ID
-   def create_mega_sign(mega_sign)
-      mega_sign_response = Echosign::Request.create_mega_sign(mega_sign, token, mega_sign.user_id, mega_sign.user_email)
+    # Creates an mega_sign
+    #
+    # @param mega_sign [Echosign::Agreement]
+    # @return [String] Agreement ID
+    def create_mega_sign(mega_sign)
+      mega_sign_response = request(:create_mega_sign, mega_sign, mega_sign.user_id, mega_sign.user_email)
       puts mega_sign_response.inspect
       mega_sign_response.fetch("mega_signId")
-   end
-
-   # Gets list of mega_signs
-   #
-   # @param mega_sign [Echosign::Agreement]
-   # @return [String] Agreement ID
-   def get_mega_signs
-     get_mega_signs_response = Echosign::Request.get_mega_signs(token)
-     get_mega_signs_response.fetch("userAgreementList")
-   end
+    end
 
-   # Gets detailed info on an mega_sign
-   # 
-   # @param mega_sign_id [String] ID of mega_sign to retrieve info on.
-   # @return [Hash] Detailed mega_sign info
-   def mega_sign_info(mega_sign_id)
-     Echosign::Request.mega_sign_info(token, mega_sign_id)
-   end
+    # Gets list of mega_signs
+    #
+    # @return [Hash] An array of mega sign parent agreements
+    def get_mega_signs
+      get_mega_signs_response = request(:get_mega_signs)
+      get_mega_signs_response.fetch("megaSignList")
+    end
 
-   # Cancel mega_sign
-   # 
-   # @param mega_sign_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_mega_sign(mega_sign_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 mega_sign
+    #
+    # @param mega_sign_id [String] ID of mega_sign to retrieve info on.
+    # @return [Hash] Detailed mega_sign info
+    def mega_sign_info(mega_sign_id)
+      request(:mega_sign_info, mega_sign_id)
+    end
 
-     mega_sign_status_response = Echosign::Request.update_mega_sign_status(token, mega_sign_id, request_body)
-     mega_sign_status_response.fetch('result')
-   end
+    # Cancel mega_sign
+    #
+    # @param mega_sign_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_mega_sign(mega_sign_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 mega_sign
-   # 
-   # @param mega_sign_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 mega_sign as provided by mega_sign_info().  If not provided, the latest version of the mega_sign is used.
-   # @return [Array] Documents relating to mega_sign.
-   def mega_sign_documents(mega_sign_id, recipient_email, format, version_id=nil)
-     result = Echosign::Request.mega_sign_documents(token, mega_sign_id, recipient_email, format, version_id)
-   end
+      mega_sign_status_response = request(:update_mega_sign_status, mega_sign_id, request_body)
+      mega_sign_status_response.fetch('result')
+    end
 
-   # Retrieve a document file from an mega_sign
-   #
-   # @param mega_sign_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 mega_sign_document_file(mega_sign_id, document_id, file_path=nil)
-     response = Echosign::Request.mega_sign_document_file(token, mega_sign_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 mega_sign
+    #
+    # @param mega_sign_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 mega_sign as provided by mega_sign_info().  If not provided, the
+    #   latest version of the mega_sign is used.
+    # @return [Array] Documents relating to mega_sign.
+    def mega_sign_documents(mega_sign_id, recipient_email, format, version_id = nil)
+      result = request(:mega_sign_documents, mega_sign_id, recipient_email, format, version_id)
+    end
 
-   # Retrieves the URL for the eSign page for the current signer(s) of an mega_sign
-   #
-   # @param mega_sign_id [String]  (REQUIRED)
-   # @return [Hash] URL information for the eSign page of the mega_sign
-   def mega_sign_signing_urls(mega_sign_id)
-     response = Echosign::Request.mega_sign_signing_urls(token, mega_sign_id)
-   end
+    # Retrieve a document file from an mega_sign
+    #
+    # @param mega_sign_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 mega_sign_document_file(mega_sign_id, document_id, file_path = nil)
+      response = request(:mega_sign_document_file, mega_sign_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 mega_sign.
-   # 
-   # @param mega_sign_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 mega_sign as provided by get_mega_sign. 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 mega_sign PDF. Default value of this parameter is true.
-   # @param auditReport [Boolean] When set to YES, attach an audit report to the signed mega_sign PDF. Default value is false
-   # @return [String] Raw bytes from document file
-   def mega_sign_combined_pdf(mega_sign_id, file_path=nil, versionId=nil, participantEmail=nil, attachSupportingDocuments=true, auditReport=false)
-     response = Echosign::Request.mega_sign_combined_pdf(token, mega_sign_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 mega_sign
+    #
+    # @param mega_sign_id [String]  (REQUIRED)
+    # @return [Hash] URL information for the eSign page of the mega_sign
+    def mega_sign_signing_urls(mega_sign_id)
+      response = request(:mega_sign_signing_urls, mega_sign_id)
+    end
 
-   # Retrieves library document audit trail file
-   # 
-   # @param mega_sign_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 mega_sign_form_data(mega_sign_id, file_path=nil)
-     response = Echosign::Request.mega_sign_form_data(token, mega_sign_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 mega_sign.
+    #
+    # @param mega_sign_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 mega_sign as provided by get_mega_sign. 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 mega_sign PDF. Default value of this parameter is true.
+    # @param auditReport [Boolean] When set to YES, attach an audit report to the signed mega_sign PDF. Default
+    #   value is false
+    # @return [String] Raw bytes from document file
+    def mega_sign_combined_pdf(mega_sign_id, file_path = nil, versionId = nil, participantEmail = nil,
+                               attachSupportingDocuments = true, auditReport = false)
+      response = request(:mega_sign_combined_pdf, mega_sign_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 mega_sign_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 mega_sign_form_data(mega_sign_id, file_path = nil)
+      response = request(:mega_sign_form_data, mega_sign_id)
+      unless file_path.nil?
+        file = File.new(file_path, 'wb')
+        file.write(response)
+        file.close
+      end
+      response
+    end
   end
 end