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/WidgetCompletionInfo.html ADDED

@@ -0,0 +1,309 @@
+<!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::WidgetCompletionInfo
+    &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/WidgetCompletionInfo.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">WidgetCompletionInfo</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::WidgetCompletionInfo
+</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::WidgetCompletionInfo</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_completion_info.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)">- (WidgetCompletionInfo) <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::WidgetCompletionInfo (class)">WidgetCompletionInfo</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">:url</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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)</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:deframe</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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.</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:delay</span>
+          <span class="type">(<tt>Fixnum</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>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</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_completion_info.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'>:url</span><span class='rbracket'>]</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/WidgetPersonalization.html ADDED

@@ -0,0 +1,326 @@
+<!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::WidgetPersonalization
+    &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/WidgetPersonalization.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">WidgetPersonalization</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::WidgetPersonalization
+</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::WidgetPersonalization</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_personalization.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)">- (Echochamber::Validatable) <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="Validatable.html" title="Echochamber::Validatable (module)">Echochamber::Validatable</a></span></tt>) <strong>initialize</strong>(params)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Initialization object</p>
+<p>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.,</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>a customizable set of options</p>
+</div>
+    </li>
+</ul>
+    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
+    <ul class="option">
+        <li>
+          <span class="name">:email</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+              &mdash; default:
+              <tt>string</tt>
+          </span>
+            &mdash; <div class='inline'>
+<p>: The email address of the person who will be receiving this widget
+(REQUIRED)</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:expiration</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>Expiration date for the personalization of this widget. After this date,
+the identity of the signer will not be assumed by EchoSign.</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:comment</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>Comment describing how the API caller established the signer&#39;s identity
+- will appear in the audit trail.</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:reusable</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>Should the intended signer be allowed to sign this widget more than once</p>
+</div>
+        </li>
+        <li>
+          <span class="name">:allowManualVerification</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+          </span>
+            &mdash; <div class='inline'>
+<p>Not used at this time,</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/echochamber/widget/widget_personalization.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'>:email</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>