RubyGems - echosign - Versions diffs - 1.0.2 → 1.5.0 - Mend

echosign 1.0.2 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (132) hide show

checksums.yaml +4 -4
data/.gitignore +2 -1
data/.rubocop.yml +14 -0
data/.rubocop_todo.yml +241 -0
data/.simplecov +2 -0
data/.travis.yml +9 -0
data/Gemfile +3 -3
data/Gemfile.lock +74 -48
data/README.md +43 -8
data/Rakefile +2 -2
data/doc/Echosign.html +135 -0
data/doc/Echosign/Agreement.html +545 -0
data/doc/Echosign/Client.html +5365 -0
data/doc/Echosign/CounterSignerInfo.html +267 -0
data/doc/Echosign/Credentials.html +1053 -0
data/doc/Echosign/Fileinfo.html +305 -0
data/doc/Echosign/FormFieldLocation.html +264 -0
data/doc/Echosign/MegaSign.html +533 -0
data/doc/Echosign/ParameterError.html +124 -0
data/doc/Echosign/PhoneInfo.html +281 -0
data/doc/Echosign/Recipient.html +311 -0
data/doc/Echosign/RecipientSecurityOption.html +296 -0
data/doc/Echosign/Refresh.html +288 -0
data/doc/Echosign/Reminder.html +279 -0
data/doc/Echosign/Request.html +5289 -0
data/doc/Echosign/Request/EndpointHash.html +328 -0
data/doc/Echosign/Request/Failure.html +290 -0
data/doc/Echosign/RequestFormField.html +244 -0
data/doc/Echosign/RequiredParameterError.html +124 -0
data/doc/Echosign/UrlFileInfo.html +297 -0
data/doc/Echosign/User.html +422 -0
data/doc/Echosign/Validatable.html +355 -0
data/doc/Echosign/Widget.html +924 -0
data/doc/Echosign/WidgetCompletionInfo.html +323 -0
data/doc/Echosign/WidgetPersonalization.html +330 -0
data/doc/Echosign/WidgetSecurityOption.html +361 -0
data/doc/Echosign/WidgetSignerSecurityOption.html +298 -0
data/doc/Echosign/WidgetStatus.html +316 -0
data/doc/Echosign/WidgetVaultingInfo.html +267 -0
data/doc/_index.html +378 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +496 -0
data/doc/file.README.html +191 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +191 -0
data/doc/js/app.js +292 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +1035 -0
data/doc/top-level-namespace.html +110 -0
data/echosign.gemspec +18 -20
data/features/support/env.rb +8 -8
data/fixtures/vcr_cassettes/agreement_combined_pdf.yml +2 -2
data/fixtures/vcr_cassettes/agreement_document_file.yml +1 -1
data/fixtures/vcr_cassettes/agreement_documents.yml +2 -2
data/fixtures/vcr_cassettes/agreement_form_data.yml +1 -1
data/fixtures/vcr_cassettes/agreement_info.yml +1 -1
data/fixtures/vcr_cassettes/agreement_signing_urls.yml +1 -1
data/fixtures/vcr_cassettes/audit_trail_pdf.yml +1 -1
data/fixtures/vcr_cassettes/cancel_agreement.yml +1 -1
data/fixtures/vcr_cassettes/create_agreement.yml +1 -1
data/fixtures/vcr_cassettes/create_reminder.yml +1 -1
data/fixtures/vcr_cassettes/create_transient_document.yml +1 -1
data/fixtures/vcr_cassettes/create_user.yml +1 -1
data/fixtures/vcr_cassettes/create_widget.yml +1 -1
data/fixtures/vcr_cassettes/get_agreements.yml +1 -1
data/fixtures/vcr_cassettes/get_library_document.yml +1 -1
data/fixtures/vcr_cassettes/get_library_document_data.yml +1 -1
data/fixtures/vcr_cassettes/get_library_document_file.yml +1 -1
data/fixtures/vcr_cassettes/get_library_documents.yml +1 -1
data/fixtures/vcr_cassettes/get_token.yml +22 -20
data/fixtures/vcr_cassettes/get_user.yml +1 -1
data/fixtures/vcr_cassettes/get_users.yml +2 -2
data/fixtures/vcr_cassettes/get_widget.yml +1 -1
data/fixtures/vcr_cassettes/get_widget_document_file.yml +1 -1
data/fixtures/vcr_cassettes/get_widget_documents.yml +1 -1
data/fixtures/vcr_cassettes/get_widgets.yml +1 -1
data/fixtures/vcr_cassettes/library_combined_document.yml +2 -2
data/fixtures/vcr_cassettes/library_document_audit_trail.yml +1 -1
data/fixtures/vcr_cassettes/personalize_widget.yml +1 -1
data/fixtures/vcr_cassettes/refresh_token.yml +46 -0
data/fixtures/vcr_cassettes/revoke_token.yml +44 -0
data/fixtures/vcr_cassettes/update_widget_status.yml +1 -1
data/lib/echosign.rb +11 -11
data/lib/echosign/agreement.rb +26 -10
data/lib/echosign/agreement/client.rb +111 -104
data/lib/echosign/agreement/fileinfo.rb +1 -3
data/lib/echosign/agreement/form_field_location.rb +2 -3
data/lib/echosign/agreement/phone_info.rb +5 -5
data/lib/echosign/agreement/recipient.rb +9 -8
data/lib/echosign/agreement/recipient_security_option.rb +5 -4
data/lib/echosign/agreement/request.rb +33 -43
data/lib/echosign/agreement/request_form_field.rb +2 -3
data/lib/echosign/agreement/url_file_info.rb +8 -6
data/lib/echosign/client.rb +33 -24
data/lib/echosign/credentials.rb +95 -24
data/lib/echosign/library_documents/client.rb +18 -23
data/lib/echosign/library_documents/request.rb +19 -20
data/lib/echosign/mega_sign.rb +20 -10
data/lib/echosign/mega_sign/client.rb +109 -104
data/lib/echosign/mega_sign/request.rb +32 -43
data/lib/echosign/refresh.rb +6 -10
data/lib/echosign/reminder.rb +2 -2
data/lib/echosign/request.rb +85 -75
data/lib/echosign/user.rb +13 -7
data/lib/echosign/validatable.rb +6 -10
data/lib/echosign/version.rb +1 -1
data/lib/echosign/widget.rb +53 -27
data/lib/echosign/widget/client.rb +33 -36
data/lib/echosign/widget/counter_signer_info.rb +4 -5
data/lib/echosign/widget/request.rb +28 -52
data/lib/echosign/widget/widget_completion_info.rb +22 -12
data/lib/echosign/widget/widget_personalization.rb +9 -7
data/lib/echosign/widget/widget_security_option.rb +21 -11
data/lib/echosign/widget/widget_signer_security_option.rb +8 -6
data/lib/echosign/widget/widget_status.rb +10 -8
data/lib/echosign/widget/widget_vaulting_info.rb +4 -5
data/spec/lib/agreement/client_spec.rb +25 -31
data/spec/lib/client_spec.rb +15 -18
data/spec/lib/credentials_spec.rb +48 -0
data/spec/lib/library_documents/client_spec.rb +11 -15
data/spec/lib/shared_client.rb +9 -16
data/spec/lib/user_spec.rb +0 -2
data/spec/lib/validatable_spec.rb +12 -18
data/spec/lib/version_spec.rb +1 -1
data/spec/lib/widget/client_spec.rb +46 -49
data/spec/spec_helper.rb +12 -5
metadata +125 -60
data/spec/lib/request_spec.rb +0 -18

data/doc/Echosign/WidgetSecurityOption.html ADDED

@@ -0,0 +1,361 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: Echosign::WidgetSecurityOption
+    &mdash; Documentation by YARD 0.9.16
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "Echosign::WidgetSecurityOption";
+  relpath = '../';
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (W)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Echosign.html" title="Echosign (module)">Echosign</a></span></span>
+     &raquo;
+    <span class="title">WidgetSecurityOption</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Class: Echosign::WidgetSecurityOption
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Hash</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">Hash</li>
+            <li class="next">Echosign::WidgetSecurityOption</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+      <dt>Includes:</dt>
+      <dd><span class='object_link'><a href="Validatable.html" title="Echosign::Validatable (module)">Validatable</a></span></dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/echosign/widget/widget_security_option.rb</dd>
+  </dl>
+</div>
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(params)  &#x21d2; WidgetSecurityOption </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Widget initialization object.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Validatable.html" title="Echosign::Validatable (module)">Validatable</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Validatable.html#require_exactly_one-instance_method" title="Echosign::Validatable#require_exactly_one (method)">#require_exactly_one</a></span>, <span class='object_link'><a href="Validatable.html#require_keys-instance_method" title="Echosign::Validatable#require_keys (method)">#require_keys</a></span>, <span class='object_link'><a href="Validatable.html#validate_field-instance_method" title="Echosign::Validatable#validate_field (method)">#validate_field</a></span></p>
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    #<strong>initialize</strong>(params)  &#x21d2; <tt><span class='object_link'><a href="" title="Echosign::WidgetSecurityOption (class)">WidgetSecurityOption</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Widget initialization object</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>params</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>SYMBOL-referenced Hash containing:</p>
+</div>
+    </li>
+</ul>
+    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
+    <ul class="option">
+        <li>
+          <span class="name">:passwordProtection</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:kbaProtection</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:webIdentityProtection</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:protectOpen</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:internalPassword</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:externalPassword</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:openPassword</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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</p>
+</div>
+        </li>
+    </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+28
+29
+30</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/echosign/widget/widget_security_option.rb', line 28</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+</div>
+      <div id="footer">
+  Generated on Thu Oct 18 12:44:51 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.6.0).
+</div>
+    </div>
+  </body>
+</html>

data/doc/Echosign/WidgetSignerSecurityOption.html ADDED

@@ -0,0 +1,298 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: Echosign::WidgetSignerSecurityOption
+    &mdash; Documentation by YARD 0.9.16
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "Echosign::WidgetSignerSecurityOption";
+  relpath = '../';
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (W)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Echosign.html" title="Echosign (module)">Echosign</a></span></span>
+     &raquo;
+    <span class="title">WidgetSignerSecurityOption</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Class: Echosign::WidgetSignerSecurityOption
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Hash</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">Hash</li>
+            <li class="next">Echosign::WidgetSignerSecurityOption</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+      <dt>Includes:</dt>
+      <dd><span class='object_link'><a href="Validatable.html" title="Echosign::Validatable (module)">Validatable</a></span></dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/echosign/widget/widget_signer_security_option.rb</dd>
+  </dl>
+</div>
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(params)  &#x21d2; WidgetSignerSecurityOption </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Initialization object.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Validatable.html" title="Echosign::Validatable (module)">Validatable</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Validatable.html#require_exactly_one-instance_method" title="Echosign::Validatable#require_exactly_one (method)">#require_exactly_one</a></span>, <span class='object_link'><a href="Validatable.html#require_keys-instance_method" title="Echosign::Validatable#require_keys (method)">#require_keys</a></span>, <span class='object_link'><a href="Validatable.html#validate_field-instance_method" title="Echosign::Validatable#validate_field (method)">#validate_field</a></span></p>
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    #<strong>initialize</strong>(params)  &#x21d2; <tt><span class='object_link'><a href="" title="Echosign::WidgetSignerSecurityOption (class)">WidgetSignerSecurityOption</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Initialization object</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>params</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>SYMBOL-referenced Hash containing:</p>
+</div>
+    </li>
+</ul>
+    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
+    <ul class="option">
+        <li>
+          <span class="name">:authenticationMethod</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>[&#39;INHERITED_FROM_DOCUMENT&#39; or &#39;KBA&#39; or &#39;PASSWORD&#39;
+or &#39;WEB_IDENTITY&#39; or &#39;PHONE&#39; or &#39;NONE&#39;]: 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</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:password</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>The password required for the recipient to view and sign the widget</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:phoneInfos</span>
+          <span class="type">(<tt>Array</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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</p>
+</div>
+        </li>
+    </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+15
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/echosign/widget/widget_signer_security_option.rb', line 15</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_require_keys'>require_keys</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:authenticationMethod</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+</div>
+      <div id="footer">
+  Generated on Thu Oct 18 12:44:51 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.6.0).
+</div>
+    </div>
+  </body>
+</html>