RubyGems - echochamber - Versions diffs - 1.0.1 - Mend

echochamber 1.0.1

Files changed (122) hide show

checksums.yaml +7 -0
data/.gitignore +4 -0
data/.rspec +2 -0
data/Gemfile +3 -0
data/Gemfile.lock +79 -0
data/LICENSE +21 -0
data/LICENSE.txt +22 -0
data/README.md +87 -0
data/Rakefile +12 -0
data/doc/Echochamber.html +131 -0
data/doc/Echochamber/Agreement.html +529 -0
data/doc/Echochamber/Agreement/UrlFileInfo.html +263 -0
data/doc/Echochamber/Client.html +4161 -0
data/doc/Echochamber/CounterSignerInfo.html +265 -0
data/doc/Echochamber/Credentials.html +330 -0
data/doc/Echochamber/Credentials/CredentialsError.html +123 -0
data/doc/Echochamber/Fileinfo.html +303 -0
data/doc/Echochamber/InvalidParameterError.html +123 -0
data/doc/Echochamber/ParameterError.html +123 -0
data/doc/Echochamber/PhoneInfo.html +279 -0
data/doc/Echochamber/Recipient.html +309 -0
data/doc/Echochamber/RecipientSecurityOption.html +294 -0
data/doc/Echochamber/Reminder.html +277 -0
data/doc/Echochamber/Request.html +4167 -0
data/doc/Echochamber/Request/Failure.html +123 -0
data/doc/Echochamber/RequiredParameterError.html +123 -0
data/doc/Echochamber/UrlFileInfo.html +295 -0
data/doc/Echochamber/User.html +420 -0
data/doc/Echochamber/Validatable.html +355 -0
data/doc/Echochamber/Validator.html +180 -0
data/doc/Echochamber/Widget.html +654 -0
data/doc/Echochamber/WidgetCompletionInfo.html +309 -0
data/doc/Echochamber/WidgetPersonalization.html +326 -0
data/doc/Echochamber/WidgetSecurityOption.html +359 -0
data/doc/Echochamber/WidgetSignerSecurityOption.html +296 -0
data/doc/Echochamber/WidgetStatus.html +314 -0
data/doc/Echochamber/WidgetVaultingInfo.html +265 -0
data/doc/_index.html +338 -0
data/doc/class_list.html +54 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +339 -0
data/doc/file.README.html +157 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +26 -0
data/doc/index.html +157 -0
data/doc/js/app.js +219 -0
data/doc/js/full_list.js +178 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +581 -0
data/doc/top-level-namespace.html +112 -0
data/echochamber.gemspec +35 -0
data/features/support/env.rb +8 -0
data/fixtures/agreement.pdf +0 -0
data/fixtures/vcr_cassettes/agreement_combined_pdf.yml +1465 -0
data/fixtures/vcr_cassettes/agreement_document_file.yml +1465 -0
data/fixtures/vcr_cassettes/agreement_documents.yml +42 -0
data/fixtures/vcr_cassettes/agreement_form_data.yml +44 -0
data/fixtures/vcr_cassettes/agreement_info.yml +50 -0
data/fixtures/vcr_cassettes/agreement_signing_urls.yml +42 -0
data/fixtures/vcr_cassettes/audit_trail_pdf.yml +1643 -0
data/fixtures/vcr_cassettes/cancel_agreement.yml +46 -0
data/fixtures/vcr_cassettes/create_agreement.yml +50 -0
data/fixtures/vcr_cassettes/create_reminder.yml +47 -0
data/fixtures/vcr_cassettes/create_transient_document.yml +716 -0
data/fixtures/vcr_cassettes/create_user.yml +50 -0
data/fixtures/vcr_cassettes/create_widget.yml +48 -0
data/fixtures/vcr_cassettes/get_agreements.yml +46 -0
data/fixtures/vcr_cassettes/get_library_document.yml +45 -0
data/fixtures/vcr_cassettes/get_library_document_data.yml +1191 -0
data/fixtures/vcr_cassettes/get_library_document_file.yml +42 -0
data/fixtures/vcr_cassettes/get_library_documents.yml +47 -0
data/fixtures/vcr_cassettes/get_token.yml +44 -0
data/fixtures/vcr_cassettes/get_user.yml +46 -0
data/fixtures/vcr_cassettes/get_users.yml +43 -0
data/fixtures/vcr_cassettes/get_widget.yml +49 -0
data/fixtures/vcr_cassettes/get_widget_document_file.yml +2682 -0
data/fixtures/vcr_cassettes/get_widget_documents.yml +44 -0
data/fixtures/vcr_cassettes/get_widgets.yml +50 -0
data/fixtures/vcr_cassettes/library_combined_document.yml +2197 -0
data/fixtures/vcr_cassettes/library_document_audit_trail.yml +1570 -0
data/fixtures/vcr_cassettes/personalize_widget.yml +47 -0
data/fixtures/vcr_cassettes/update_widget_status.yml +46 -0
data/lib/echochamber.rb +10 -0
data/lib/echochamber/agreement.rb +32 -0
data/lib/echochamber/agreement/client.rb +118 -0
data/lib/echochamber/agreement/fileinfo.rb +20 -0
data/lib/echochamber/agreement/phone_info.rb +19 -0
data/lib/echochamber/agreement/recipient.rb +23 -0
data/lib/echochamber/agreement/recipient_security_option.rb +20 -0
data/lib/echochamber/agreement/request.rb +142 -0
data/lib/echochamber/agreement/url_file_info.rb +18 -0
data/lib/echochamber/client.rb +82 -0
data/lib/echochamber/credentials.rb +33 -0
data/lib/echochamber/library_documents/client.rb +83 -0
data/lib/echochamber/library_documents/request.rb +78 -0
data/lib/echochamber/reminder.rb +17 -0
data/lib/echochamber/request.rb +141 -0
data/lib/echochamber/user.rb +29 -0
data/lib/echochamber/validatable.rb +54 -0
data/lib/echochamber/version.rb +3 -0
data/lib/echochamber/widget.rb +42 -0
data/lib/echochamber/widget/client.rb +127 -0
data/lib/echochamber/widget/counter_signer_info.rb +19 -0
data/lib/echochamber/widget/request.rb +135 -0
data/lib/echochamber/widget/widget_completion_info.rb +19 -0
data/lib/echochamber/widget/widget_personalization.rb +21 -0
data/lib/echochamber/widget/widget_security_option.rb +22 -0
data/lib/echochamber/widget/widget_signer_security_option.rb +18 -0
data/lib/echochamber/widget/widget_status.rb +20 -0
data/lib/echochamber/widget/widget_vaulting_info.rb +16 -0
data/spec/lib/agreement/client_spec.rb +157 -0
data/spec/lib/client_spec.rb +78 -0
data/spec/lib/library_documents/client_spec.rb +71 -0
data/spec/lib/request_spec.rb +18 -0
data/spec/lib/shared_client.rb +22 -0
data/spec/lib/user_spec.rb +6 -0
data/spec/lib/validatable_spec.rb +110 -0
data/spec/lib/version_spec.rb +7 -0
data/spec/lib/widget/client_spec.rb +154 -0
data/spec/spec_helper.rb +21 -0
metadata +344 -0

data/doc/Echochamber/WidgetSecurityOption.html ADDED

@@ -0,0 +1,359 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Echochamber::WidgetSecurityOption
+    &mdash; Documentation by YARD 0.8.7.4
+</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">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!Echochamber/WidgetSecurityOption.html";
+</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 id="header">
+      <div id="menu">
+    <a href="../_index.html">Index (W)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Echochamber.html" title="Echochamber (module)">Echochamber</a></span></span>
+     &raquo;
+    <span class="title">WidgetSecurityOption</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: Echochamber::WidgetSecurityOption
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Hash</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">Hash</li>
+            <li class="next">Echochamber::WidgetSecurityOption</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="Validatable.html" title="Echochamber::Validatable (module)">Validatable</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/echochamber/widget/widget_security_option.rb</dd>
+</dl>
+<div class="clear"></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)">- (WidgetSecurityOption) <strong>initialize</strong>(params) </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="Echochamber::Validatable (module)">Validatable</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Validatable.html#require_exactly_one-instance_method" title="Echochamber::Validatable#require_exactly_one (method)">#require_exactly_one</a></span>, <span class='object_link'><a href="Validatable.html#require_keys-instance_method" title="Echochamber::Validatable#require_keys (method)">#require_keys</a></span>, <span class='object_link'><a href="Validatable.html#validate_field-instance_method" title="Echochamber::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">
+    - (<tt><span class='object_link'><a href="" title="Echochamber::WidgetSecurityOption (class)">WidgetSecurityOption</a></span></tt>) <strong>initialize</strong>(params)
+</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">
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/echochamber/widget/widget_security_option.rb', line 16</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 Aug 21 05:14:34 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.0.0).
+</div>
+  </body>
+</html>

data/doc/Echochamber/WidgetSignerSecurityOption.html ADDED

@@ -0,0 +1,296 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Echochamber::WidgetSignerSecurityOption
+    &mdash; Documentation by YARD 0.8.7.4
+</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">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!Echochamber/WidgetSignerSecurityOption.html";
+</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 id="header">
+      <div id="menu">
+    <a href="../_index.html">Index (W)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Echochamber.html" title="Echochamber (module)">Echochamber</a></span></span>
+     &raquo;
+    <span class="title">WidgetSignerSecurityOption</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: Echochamber::WidgetSignerSecurityOption
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Hash</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">Hash</li>
+            <li class="next">Echochamber::WidgetSignerSecurityOption</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="Validatable.html" title="Echochamber::Validatable (module)">Validatable</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/echochamber/widget/widget_signer_security_option.rb</dd>
+</dl>
+<div class="clear"></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)">- (WidgetSignerSecurityOption) <strong>initialize</strong>(params) </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="Echochamber::Validatable (module)">Validatable</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Validatable.html#require_exactly_one-instance_method" title="Echochamber::Validatable#require_exactly_one (method)">#require_exactly_one</a></span>, <span class='object_link'><a href="Validatable.html#require_keys-instance_method" title="Echochamber::Validatable#require_keys (method)">#require_keys</a></span>, <span class='object_link'><a href="Validatable.html#validate_field-instance_method" title="Echochamber::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">
+    - (<tt><span class='object_link'><a href="" title="Echochamber::WidgetSignerSecurityOption (class)">WidgetSignerSecurityOption</a></span></tt>) <strong>initialize</strong>(params)
+</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 [Echochamber::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">
+12
+13
+14
+15</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/echochamber/widget/widget_signer_security_option.rb', line 12</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 Aug 21 05:14:34 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.0.0).
+</div>
+  </body>
+</html>