echosign 1.0.2 → 1.5.0

data/lib/echosign/widget/widget_completion_info.rb

@@ -1,25 +1,35 @@
 module Echosign
   class WidgetCompletionInfo < Hash
-
     include Validatable
 
     # Widget initialization object
-    # 
+    #
     # @param [Hash] params SYMBOL-referenced Hash containing:
-    # @option params [String] :url A publicly accessible url to which the user will be sent after successfully completing the widget. If the URL you provide includes information that allows you to identify the specific transaction, such as your own unique identifier, you can use the browser request to this URL as a callback to notify you that this transaction is completed. In addition, EchoSign will append a documentKey parameter to the URL which will contain the EchoSign DocumentKey for this signed widget, but only if the sender is the same as the API key user. Your application can use this value to get the form data for this widget. (REQUIRED)
-    # @option params [Boolean] :deframe If deframe is false, the success page will be shown inside the widget frame. If deframe is true, the success page will be shown in the full browser window. Note that if this widget is loaded through javascript returned from this end point, browser security restrictions do not permit automatic redirection in the full browser window, so if deframe is true the user will instead just see a link to the success page. We recommend this scenario be avoided - in other words, setting deframe to false is recommended for this case.
-    # @option params [Fixnum] :delay The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard EchoSign success message, and then after a delay will be redirected to your success page. Note that this parameter has no effect for widgets loaded with javascript when deframe is true 
+    # @option params [String] :url A publicly accessible url to which the user will be sent after successfully
+    #   completing the widget. If the URL you provide includes information that allows you to identify the specific
+    #   transaction, such as your own unique identifier, you can use the browser request to this URL as a callback
+    #   to notify you that this transaction is completed. In addition, EchoSign will append a documentKey parameter
+    #   to the URL which will contain the EchoSign DocumentKey for this signed widget, but only if the sender is the
+    #   same as the API key user. Your application can use this value to get the form data for this widget. (REQUIRED)
+    # @option params [Boolean] :deframe If deframe is false, the success page will be shown inside the widget frame.
+    #   If deframe is true, the success page will be shown in the full browser window. Note that if this widget is
+    #   loaded through javascript returned from this end point, browser security restrictions do not permit
+    #   automatic redirection in the full browser window, so if deframe is true the user will instead just see a
+    #   link to the success page. We recommend this scenario be avoided - in other words, setting deframe to false
+    #   is recommended for this case.
+    # @option params [Fixnum] :delay The delay (in seconds) before the user is taken to the success page. If this
+    #   value is greater than 0, the user will first see the standard EchoSign success message, and then after a
+    #   delay will be redirected to your success page. Note that this parameter has no effect for widgets loaded
+    #   with javascript when deframe is true
     def initialize(params)
       require_keys([:url])
       merge!(
-      {
-        :deframe => deframe,
-        :delay => delay,
-        :url => url,
-      }
+        {
+          deframe: deframe,
+          delay: delay,
+          url: url,
+        }
       )
     end
-
   end
 end
-

data/lib/echosign/widget/widget_personalization.rb

@@ -1,14 +1,17 @@
 module Echosign
   class WidgetPersonalization < Hash
-
     include Validatable
 
     # Initialization object
-    # 
-    # @option params [String] :email (string): The email address of the person who will be receiving this widget (REQUIRED)
-    # expiration (date, optional): Expiration date for the personalization of this widget. After this date, the identity of the signer will not be assumed by EchoSign.,
-    # @option params [String] :expiration Expiration date for the personalization of this widget. After this date, the identity of the signer will not be assumed by EchoSign. 
-    # @option params [String] :comment Comment describing how the API caller established the signer's identity - will appear in the audit trail.
+    #
+    # @option params [String] :email (string): The email address of the person who will be receiving this widget
+    #   (REQUIRED)
+    # expiration (date, optional): Expiration date for the personalization of this widget. After this date, the
+    #   identity of the signer will not be assumed by EchoSign.,
+    # @option params [String] :expiration Expiration date for the personalization of this widget. After this date,
+    #   the identity of the signer will not be assumed by EchoSign.
+    # @option params [String] :comment Comment describing how the API caller established the signer's identity -
+    #   will appear in the audit trail.
     # @option params [Boolean] :reusable Should the intended signer be allowed to sign this widget more than once
     # @option params [Boolean] :allowManualVerification Not used at this time,
     # @return [Echosign::Validatable]
@@ -16,6 +19,5 @@ module Echosign
       require_keys([:email], params)
       merge!(params)
     end
-
   end
 end

data/lib/echosign/widget/widget_security_option.rb

@@ -1,22 +1,32 @@
 module Echosign
   class WidgetSecurityOption < Hash
-
     include Validatable
 
     # Widget initialization object
-    # 
+    #
     # @param [Hash] params SYMBOL-referenced Hash containing:
-    # @option params [String] :passwordProtection Specifies if signers are required to enter a password to have access to sign the widget. The possible values are NONE, EXTERNAL_USERS, INTERNAL_USERS, or ALL_USERS
-    # @option params [String] :kbaProtection Signers need to pass Knowledge Based Authentication before they gain access to view and sign the widget. The possible values are NONE, EXTERNAL_USERS, INTERNAL_USERS, or ALL_USERS
-    # @option params [String] :webIdentityProtection Specifies if signers are required to provide their web identity, before they gain access to view and sign the widget. The possible values are NONE, EXTERNAL_USERS, INTERNAL_USERS, or ALL_USERS 
-    # @option params [Boolean] :protectOpen If set to true, the document is always be encrypted with this password every time it is sent by email. Recipients need to provide the password to be able to view the PDF files
-    # @option params [String] :internalPassword The secondary password that will be used to protect signing the widget for internal signers. Note that EchoSign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for internal signers or all signers
-    # @option params [String] :externalPassword The secondary password that will be used to protect signing the widget for external signers. Note that EchoSign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for external signers or all signers
-    # @option params [String] :openPassword The secondary password that will be used to secure the PDF document. Note that EchoSign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is used only if protectOpen field is set to true
+    # @option params [String] :passwordProtection Specifies if signers are required to enter a password to have
+    #   access to sign the widget. The possible values are NONE, EXTERNAL_USERS, INTERNAL_USERS, or ALL_USERS
+    # @option params [String] :kbaProtection Signers need to pass Knowledge Based Authentication before they gain
+    #   access to view and sign the widget. The possible values are NONE, EXTERNAL_USERS, INTERNAL_USERS, or ALL_USERS
+    # @option params [String] :webIdentityProtection Specifies if signers are required to provide their web
+    #   identity, before they gain access to view and sign the widget. The possible values are NONE, EXTERNAL_USERS,
+    #   INTERNAL_USERS, or ALL_USERS
+    # @option params [Boolean] :protectOpen If set to true, the document is always be encrypted with this password
+    #   every time it is sent by email. Recipients need to provide the password to be able to view the PDF files
+    # @option params [String] :internalPassword The secondary password that will be used to protect signing the
+    #   widget for internal signers. Note that EchoSign will never show this password to anyone, so you will need to
+    #   separately communicate it to any relevant parties. This password is applied only if password protection is
+    #   specified for internal signers or all signers
+    # @option params [String] :externalPassword The secondary password that will be used to protect signing the
+    #   widget for external signers. Note that EchoSign will never show this password to anyone, so you will need to
+    #   separately communicate it to any relevant parties. This password is applied only if password protection is
+    #   specified for external signers or all signers
+    # @option params [String] :openPassword The secondary password that will be used to secure the PDF document.
+    #   Note that EchoSign will never show this password to anyone, so you will need to separately communicate it to
+    #   any relevant parties. This password is used only if protectOpen field is set to true
     def initialize(params)
       merge!(params)
     end
-
   end
 end
-

data/lib/echosign/widget/widget_signer_security_option.rb

@@ -1,18 +1,20 @@
 module Echosign
   class WidgetSignerSecurityOption < Hash
-
     include Validatable
 
     # Initialization object
-    # 
-    # @param [Hash] params SYMBOL-referenced Hash containing: 
-    # @option params [String] :authenticationMethod ['INHERITED_FROM_DOCUMENT' or 'KBA' or 'PASSWORD' or 'WEB_IDENTITY' or 'PHONE' or 'NONE']: The authentication method for the recipients to have access to view and sign the widget. PHONE authentication is only applicable to counter signers but not to widget signer
+    #
+    # @param [Hash] params SYMBOL-referenced Hash containing:
+    # @option params [String] :authenticationMethod ['INHERITED_FROM_DOCUMENT' or 'KBA' or 'PASSWORD' or
+    #   'WEB_IDENTITY' or 'PHONE' or 'NONE']: The authentication method for the recipients to have access to view
+    #   and sign the widget. PHONE authentication is only applicable to counter signers but not to widget signer
     # @option params [String] :password The password required for the recipient to view and sign the widget
-    # @option params [Array] :phoneInfos Populated with instances of [Echosign::PhoneInfo] The phoneInfo required for the counter signer to view and sign the widget if authentication method is PHONE. Not applicable to widget signer
+    # @option params [Array] :phoneInfos Populated with instances of [Echosign::PhoneInfo] The phoneInfo required
+    #   for the counter signer to view and sign the widget if authentication method is PHONE. Not applicable to
+    #   widget signer
     def initialize(params)
       require_keys([:authenticationMethod], params)
       merge!(params)
     end
-
   end
 end

data/lib/echosign/widget/widget_status.rb

@@ -1,20 +1,22 @@
 module Echosign
-  class WidgetStatus< Hash
-
+  class WidgetStatus < Hash
     include Validatable
 
-    # Status object 
-    # 
+    # Status object
+    #
     # @option [Hash] params
-    # @option params [String] :value The status to which the widget is to be updated. The possible values for this variable are ENABLE and DISABLE (REQUIRED)
-    # @option params [String] :message Display this custom message to the user when the widget is accessed. Note that this can contain wiki markup to include clickable links in the message. This is required if redirectUrl is not provided. Both message and redirectUrl can not be specified
-    # @option params [String] :redirectUrl Redirect the user to this URL when the widget is accessed. This is required if message is not provided. Both message and redirectUrl can not be specified
+    # @option params [String] :value The status to which the widget is to be updated. The possible values for this
+    #   variable are ENABLE and DISABLE (REQUIRED)
+    # @option params [String] :message Display this custom message to the user when the widget is accessed. Note
+    #   that this can contain wiki markup to include clickable links in the message. This is required if redirectUrl
+    #   is not provided. Both message and redirectUrl can not be specified
+    # @option params [String] :redirectUrl Redirect the user to this URL when the widget is accessed. This is
+    #   required if message is not provided. Both message and redirectUrl can not be specified
     # @return [Echosign::WidgetStatus]
     def initialize(params)
       require_keys([:value], params)
       require_exactly_one([:message, :redirectUrl], params)
       merge!(params)
     end
-
   end
 end

data/lib/echosign/widget/widget_vaulting_info.rb

@@ -1,16 +1,15 @@
 module Echosign
   class WidgetVaultingInfo < Hash
-
     include Validatable
 
     # Initialization object
-    # 
-    # @param [Hash] params SYMBOL-referenced Hash containing: 
-    # @option params [Boolean] :enabled For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted
+    #
+    # @param [Hash] params SYMBOL-referenced Hash containing:
+    # @option params [Boolean] :enabled For accounts set up for document vaulting and the option to enable per
+    #   agreement, this determines whether the document is to be vaulted
     def initialize(params)
       require_keys([:enabled], params)
       merge!(params)
     end
-
   end
 end

data/spec/lib/agreement/client_spec.rb

@@ -6,42 +6,41 @@ describe Echosign::Client do
   include_context "shared client"
 
   describe '.create_agreement' do
-
     let(:url_file_info) do
       {
-      url: 'http://findgoplayers.com/resume.pdf',
-      mimeType: 'application/pdf',
-      name: 'resume.pdf'
+        url: 'http://findgoplayers.com/resume.pdf',
+        mimeType: 'application/pdf',
+        name: 'resume.pdf'
       }
     end
 
     let(:file_info) do
-      { 
-        documentURL: Echosign::UrlFileInfo.new(url_file_info) 
+      {
+        documentURL: Echosign::UrlFileInfo.new(url_file_info)
       }
     end
 
     let(:file_infos) do
-      [ Echosign::Fileinfo.new(file_info) ] 
+      [Echosign::Fileinfo.new(file_info)]
     end
 
-    let(:agreement_user_id) { nil } 
+    let(:agreement_user_id) { nil }
     let(:agreement_user_email) { nil }
 
     let(:agreement_info) do
       {
-        fileInfos: [ file_infos ],
-        recipients: [ Echosign::Recipient.new({ role: 'SIGNER', email: 'goishi.san@gmail.com'})],
+        fileInfos: [file_infos],
+        recipientSetInfos: [Echosign::Recipient.new({ role: 'SIGNER', email: 'goishi.san@gmail.com' })],
         signatureFlow: "SENDER_SIGNS_LAST",
         signatureType: "ESIGN",
         name: "Rumplestiltskin Contract"
       }
     end
 
-    let(:agreement)  { Echosign::Agreement.new(agreement_user_id, agreement_user_email, agreement_info) }
+    let(:agreement) { Echosign::Agreement.new(agreement_user_id, agreement_user_email, agreement_info) }
 
     it 'returns the agreement_id' do
-      VCR.use_cassette('create_agreement', :record => :once) do
+      VCR.use_cassette('create_agreement', record: :once) do
         agreement_id = client.create_agreement(agreement)
         expect(agreement_id).to_not be_nil
       end
@@ -50,7 +49,7 @@ describe Echosign::Client do
 
   describe '.get_agreements' do
     it 'returns all agreements' do
-      VCR.use_cassette('get_agreements', :record => :once) do
+      VCR.use_cassette('get_agreements', record: :once) do
         response = client.get_agreements
         expect(response).to_not be_nil
       end
@@ -60,7 +59,7 @@ describe Echosign::Client do
   describe '.agreement_info' do
     let(:agreement_id) { "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*" }
     it 'returns detailed agreement info' do
-      VCR.use_cassette('agreement_info', :record => :once) do
+      VCR.use_cassette('agreement_info', record: :once) do
         response = client.agreement_info(agreement_id)
         expect(response).to_not be_nil
       end
@@ -68,20 +67,20 @@ describe Echosign::Client do
   end
 
   describe '.agreement_form_data' do
-   let(:agreement_id) { "2AAABLblqZhDvfdYluvps8mSzQXnXr074OVtMYTwTVtljZYFJNi43iuzYeBaPUUOMTSlGXrt04Sw*" }
+    let(:agreement_id) { "2AAABLblqZhDvfdYluvps8mSzQXnXr074OVtMYTwTVtljZYFJNi43iuzYeBaPUUOMTSlGXrt04Sw*" }
     it 'returns CSV data' do
-      VCR.use_cassette('agreement_form_data', :record => :once) do
+      VCR.use_cassette('agreement_form_data', record: :once) do
         response = client.agreement_form_data(agreement_id)
         expect(response).to_not be_nil
       end
-   end
+    end
   end
 
   describe '.cancel_agreement' do
     let(:agreement_id) { "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*" }
 
     it 'returns the result of the operation' do
-      VCR.use_cassette('cancel_agreement', :record => :once) do
+      VCR.use_cassette('cancel_agreement', record: :once) do
         result = client.cancel_agreement(agreement_id, true, 'Just because')
         expect(result).to_not be_nil
       end
@@ -95,7 +94,7 @@ describe Echosign::Client do
     let(:version_id) { nil }
 
     it 'returns information about documents for this agreement' do
-      VCR.use_cassette('agreement_documents', :record => :once) do
+      VCR.use_cassette('agreement_documents', record: :once) do
         result = client.agreement_documents(agreement_id, recipient_email, format, version_id)
         expect(result).to_not be_nil
       end
@@ -107,9 +106,9 @@ describe Echosign::Client do
     let(:document_id) { "2AAABLblqZhDcteEO9jy6gSat9d_3XgpPVpxhetoDCpU4L9PoolGv_3mqgKL1DhIGTXTHhqAHlHk*" }
 
     it 'returns a document file from the selected agreement' do
-      VCR.use_cassette('agreement_document_file', :record => :once) do
+      VCR.use_cassette('agreement_document_file', record: :once) do
         result = client.agreement_document_file(agreement_id, document_id)
-        expect(result).to be_a String 
+        expect(result).to be_a String
         expect(result).to_not be_nil
       end
     end
@@ -119,9 +118,9 @@ describe Echosign::Client do
     let(:agreement_id) { "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*" }
 
     it 'returns a pdf file for an audit trail on the agreement' do
-      VCR.use_cassette('audit_trail_pdf', :record => :once) do
+      VCR.use_cassette('audit_trail_pdf', record: :once) do
         result = client.audit_trail_pdf(agreement_id)
-        expect(result).to be_a String 
+        expect(result).to be_a String
         expect(result).to_not be_nil
       end
     end
@@ -131,9 +130,9 @@ describe Echosign::Client do
     let(:agreement_id) { "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*" }
 
     it 'returns a combined pdf file ' do
-      VCR.use_cassette('agreement_combined_pdf', :record => :once) do
+      VCR.use_cassette('agreement_combined_pdf', record: :once) do
         result = client.agreement_combined_pdf(agreement_id)
-        expect(result).to be_a String 
+        expect(result).to be_a String
         expect(result).to_not be_nil
       end
     end
@@ -143,15 +142,10 @@ describe Echosign::Client do
     let(:agreement_id) { "2AAABLblqZhDdfTP0uM4EIz2UE2Mq27D7PXGl7Uk3e5nO4RtzlkN8GMANmeVwUVRWGGuUGCQoRQc*" }
 
     it 'returns URL information for the agreement' do
-      VCR.use_cassette('agreement_signing_urls', :record => :once) do
+      VCR.use_cassette('agreement_signing_urls', record: :once) do
         result = client.agreement_signing_urls(agreement_id)
         expect(result).to be_a Hash
       end
     end
   end
-
-
-
 end
- 
-

data/spec/lib/client_spec.rb

@@ -17,7 +17,7 @@ describe Echosign::Client do
     let (:user) { Echosign::User.new(user_params) }
 
     it 'returns the User ID' do
-      VCR.use_cassette('create_user', :record => :once) do
+      VCR.use_cassette('create_user', record: :once) do
         user_id = client.create_user(user)
         expect(user_id).to_not be_nil
       end
@@ -25,34 +25,35 @@ describe Echosign::Client do
   end
 
   describe '.get_users' do
-   let(:email) { "cthomas@railjumper.com" }
+    let(:email) { "nobody@nobody.com" }
     it 'returns user data' do
-      VCR.use_cassette('get_users', :record => :once) do
+      VCR.use_cassette('get_users', record: :once) do
         response = client.get_users(email)
         expect(response).to be_a Hash
       end
-   end
+    end
   end
 
   describe '.get_user' do
-   let(:id) { "2AAABLblqZhBp6sZ412RCo4_5P1OCDATcuKQf3gzb7M-kea77rqC7h6kzMKSpofswP8rY9Cwv9Vw*" }
+    let(:id) { "2AAABLblqZhBp6sZ412RCo4_5P1OCDATcuKQf3gzb7M-kea77rqC7h6kzMKSpofswP8rY9Cwv9Vw*" }
     it 'returns user data' do
-      VCR.use_cassette('get_user', :record => :once) do
+      VCR.use_cassette('get_user', record: :once) do
         response = client.get_user(id)
         expect(response).to be_a Hash
       end
-   end
+    end
   end
 
   describe '.create_reminder' do
-    let(:reminderInfo) { { 
-        agreementId: "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*", 
-        comment: "Hey don't forget..." 
-    } }
+    let(:reminderInfo) {
+      {
+        agreementId: "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*",
+        comment: "Hey don't forget..."
+      } }
     let(:reminder) { Echosign::Reminder.new(reminderInfo) }
 
-    it 'returns result'  do
-      VCR.use_cassette('create_reminder', :record => :once) do
+    it 'returns result' do
+      VCR.use_cassette('create_reminder', record: :once) do
         response = client.create_reminder(reminder)
         expect(response).to be_a Hash
       end
@@ -65,14 +66,10 @@ describe Echosign::Client do
     let(:file) { File.new("fixtures/agreement.pdf", 'rb') }
 
     it 'returns the transient document ID' do
-      VCR.use_cassette('create_transient_document', :record => :once) do
+      VCR.use_cassette('create_transient_document', record: :once) do
         tran_doc_id = client.create_transient_document(file_name, mime_type, file)
         expect(tran_doc_id).to_not be_nil
       end
     end
   end
-
-
 end # describe Echosign::Client
-
-

data/spec/lib/credentials_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'lib/shared_client.rb'
+
+describe Echosign::Credentials do
+  include_context "shared client"
+
+  let(:app_id)        { "9Q444442AX82M" }
+  let(:app_secret)    { "390db09fc6672388b9457593a7" }
+
+  describe '#get_token' do
+    it 'returns the access_token' do
+      VCR.use_cassette('get_token', record: :once) do
+        redirect_uri = 'https://example.com/oauth/callback'
+        code = 'CBNCKBAAHBCAABAAsl_mVpKa1ksh2FrdZmjju5IzTQ2lynIE'
+
+        credentials = Echosign::Credentials.new(app_id, app_secret)
+        token = credentials.get_token(redirect_uri, code)
+        expect(token).to_not be_nil
+      end
+    end
+  end
+
+  describe '#refresh_access_token' do
+    it 'refreshes the access_token' do
+      VCR.use_cassette('refresh_token', record: :once) do
+        refresh_token = '3AAABLblqZhCNb-X2YXthBgBsEVpM1xC0EATrsDEo0yAmXOIlM58tuASRzYaMjhUGNbRQga8syqE*'
+
+        credentials = Echosign::Credentials.new(app_id, app_secret)
+        token = credentials.refresh_access_token(refresh_token)
+        expect(token).to_not be_nil
+      end
+    end
+  end
+
+  describe '#revoke_token' do
+    it 'revokes the access_token' do
+      VCR.use_cassette('revoke_token', record: :once) do
+        credentials = Echosign::Credentials.new(app_id, app_secret)
+
+        credentials.instance_variable_set(:@access_token, access_token) # sneaky!
+        expect(credentials.access_token).to_not be_nil
+
+        credentials.revoke_token
+        expect(credentials.access_token).to be_nil
+      end
+    end
+  end
+end