Finish finessing the documentation

kayagoban · Aug 21, 2014 · 528e01c · 528e01c
1 parent 19669d9
commit 528e01c
Show file tree

Hide file tree

Showing 37 changed files with 58 additions and 66 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    echochamber (0.0.1)
+    echochamber (1.0.0)
       faraday
       json
       rest-client

diff --git a/README.md b/README.md
@@ -23,6 +23,8 @@ It also wouldn't hurt to read Adobe's [Echosign API documentation](https://secur
 #### Initializing a client
 
 ```
+require 'echochamber'
+
 credentials = Echochamber::Credentials.new(app_id, app_secret, api_key, email, password)
 
 client = Echochamber::Client.new(credentials)

diff --git a/doc/Echochamber.html b/doc/Echochamber.html
@@ -106,7 +106,7 @@ <h2>Constant Summary</h2>
         <dt id="VERSION-constant" class="">VERSION =
 
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
 
     </dl>
 
@@ -122,7 +122,7 @@ <h2>Constant Summary</h2>
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:33 2014 by
+  Generated on Thu Aug 21 05:14:33 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>

diff --git a/doc/Echochamber/Agreement.html b/doc/Echochamber/Agreement.html
@@ -520,7 +520,7 @@ <h3 class="signature " id="user_id-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/Client.html b/doc/Echochamber/Client.html
@@ -4152,7 +4152,7 @@ <h3 class="signature " id="update_widget_status-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/CounterSignerInfo.html b/doc/Echochamber/CounterSignerInfo.html
@@ -256,7 +256,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/Credentials.html b/doc/Echochamber/Credentials.html
@@ -321,7 +321,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/Fileinfo.html b/doc/Echochamber/Fileinfo.html
@@ -294,7 +294,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/ParameterError.html b/doc/Echochamber/ParameterError.html
@@ -114,7 +114,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/PhoneInfo.html b/doc/Echochamber/PhoneInfo.html
@@ -270,7 +270,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/Recipient.html b/doc/Echochamber/Recipient.html
@@ -300,7 +300,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/RecipientSecurityOption.html b/doc/Echochamber/RecipientSecurityOption.html
@@ -285,7 +285,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/Reminder.html b/doc/Echochamber/Reminder.html
@@ -268,7 +268,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/Request.html b/doc/Echochamber/Request.html
@@ -4158,7 +4158,7 @@ <h3 class="signature " id="update_widget_status-class_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:33 2014 by
+  Generated on Thu Aug 21 05:14:33 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>

diff --git a/doc/Echochamber/Request/Failure.html b/doc/Echochamber/Request/Failure.html
@@ -114,7 +114,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/RequiredParameterError.html b/doc/Echochamber/RequiredParameterError.html
@@ -114,7 +114,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/UrlFileInfo.html b/doc/Echochamber/UrlFileInfo.html
@@ -286,7 +286,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/User.html b/doc/Echochamber/User.html
@@ -411,7 +411,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  Generated on Thu Aug 21 05:14:33 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>

diff --git a/doc/Echochamber/Validatable.html b/doc/Echochamber/Validatable.html
@@ -346,7 +346,7 @@ <h3 class="signature " id="validate_field-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  Generated on Thu Aug 21 05:14:33 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>

diff --git a/doc/Echochamber/Widget.html b/doc/Echochamber/Widget.html
@@ -645,7 +645,7 @@ <h3 class="signature " id="user_id-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/WidgetCompletionInfo.html b/doc/Echochamber/WidgetCompletionInfo.html
@@ -300,7 +300,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/WidgetPersonalization.html b/doc/Echochamber/WidgetPersonalization.html
@@ -317,7 +317,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/WidgetSecurityOption.html b/doc/Echochamber/WidgetSecurityOption.html
@@ -350,7 +350,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/WidgetSignerSecurityOption.html b/doc/Echochamber/WidgetSignerSecurityOption.html
@@ -287,7 +287,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/WidgetStatus.html b/doc/Echochamber/WidgetStatus.html
@@ -305,7 +305,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/Echochamber/WidgetVaultingInfo.html b/doc/Echochamber/WidgetVaultingInfo.html
@@ -256,7 +256,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:34 2014 by
+  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>

diff --git a/doc/_index.html b/doc/_index.html
@@ -329,7 +329,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:33 2014 by
+  Generated on Thu Aug 21 05:14:33 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>

diff --git a/doc/file.README.html b/doc/file.README.html
@@ -89,9 +89,12 @@ <h2 id="label-Usage">Usage</h2>
 
 <h4 id="label-Initializing+a+client">Initializing a client</h4>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_credentials'>credentials</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_app_secret'>app_secret</span><span class='comma'>,</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='id identifier rubyid_email'>email</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>echochamber</span><span class='tstring_end'>&#39;</span></span>
 
-<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_credentials'>credentials</span><span class='rparen'>)</span></code></pre>
+<span class='id identifier rubyid_credentials'>credentials</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_app_secret'>app_secret</span><span class='comma'>,</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='id identifier rubyid_email'>email</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_credentials'>credentials</span><span class='rparen'>)</span>
+</code></pre>
 
 <h4 id="label-Setting+up+a+new+agreement+from+a+URL">Setting up a new agreement from a URL</h4>
 
@@ -145,7 +148,7 @@ <h4 id="label-Sending+a+transient+document+for+later+referral">Sending a transie
 </div></div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:33 2014 by
+  Generated on Thu Aug 21 05:14:33 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>

diff --git a/doc/index.html b/doc/index.html
@@ -89,9 +89,12 @@ <h2 id="label-Usage">Usage</h2>
 
 <h4 id="label-Initializing+a+client">Initializing a client</h4>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_credentials'>credentials</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_app_secret'>app_secret</span><span class='comma'>,</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='id identifier rubyid_email'>email</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>echochamber</span><span class='tstring_end'>&#39;</span></span>
 
-<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_credentials'>credentials</span><span class='rparen'>)</span></code></pre>
+<span class='id identifier rubyid_credentials'>credentials</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_app_secret'>app_secret</span><span class='comma'>,</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='id identifier rubyid_email'>email</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>Echochamber</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_credentials'>credentials</span><span class='rparen'>)</span>
+</code></pre>
 
 <h4 id="label-Setting+up+a+new+agreement+from+a+URL">Setting up a new agreement from a URL</h4>
 
@@ -145,7 +148,7 @@ <h4 id="label-Sending+a+transient+document+for+later+referral">Sending a transie
 </div></div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:33 2014 by
+  Generated on Thu Aug 21 05:14:33 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>

diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html
@@ -103,7 +103,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
     <div id="footer">
-  Generated on Thu Aug 21 04:34:33 2014 by
+  Generated on Thu Aug 21 05:14:33 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>

diff --git a/echochamber.gemspec b/echochamber.gemspec
@@ -6,8 +6,8 @@ require 'echochamber/version'
 Gem::Specification.new do |spec|
   spec.name          = "echochamber"
   spec.version       = Echochamber::VERSION
-  spec.authors       = ["C. Thomas"]
-  spec.email         = ["goishi.san@gmail.com"]
+  spec.authors       = ["Cath Thomas"]
+  spec.email         = ["cthomas@railjumper.com"]
   spec.summary       = %q{Package summary}
   spec.description   = %q{A ruby gem that simplifies the use of Adobe's EchoSign web API.}
   spec.homepage      = "http://github.com/kayagoban/echochamber"

diff --git a/fixtures/vcr_cassettes/get_token.yml b/fixtures/vcr_cassettes/get_token.yml
diff --git a/lib/echochamber/version.rb b/lib/echochamber/version.rb
@@ -1,3 +1,3 @@
 module Echochamber
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end
diff --git a/spec/lib/client_spec.rb b/spec/lib/client_spec.rb
@@ -4,10 +4,6 @@
 describe Echochamber::Client do
   include_context "shared client"
 
-  describe '#initialize' do
-    pending 'calls Echochamber::Request.get_token with credentials'
-  end
-
   describe '.create_user' do
     let (:user_params) do
       {

diff --git a/spec/lib/request_spec.rb b/spec/lib/request_spec.rb
@@ -1,17 +1,8 @@
 require 'spec_helper'
+require 'lib/shared_client.rb'
 
 describe Echochamber::Request do
-
-  let(:app_id)        { "9QCM5C6Y2AX82M" }
-  let(:app_secret)    { "390db093ee6f71ffc6d488b9457593a7" }
-  let(:api_key)       { "XCNLJFG83URX95Y" }
-  let(:email)         { "[email protected]" }
-  let(:password)      { "badpassword" }
-
-  let(:credentials) do  
-    Echochamber::Credentials.new(app_id, app_secret, api_key, email, password)
-  end
-
+  include_context "shared client"
 
   describe '#get_token' do
 
@@ -24,11 +15,4 @@
 
   end
 
-
-  describe '#create_user' do
-
-    pending 'calls RestClient.post'
-
-  end
-
 end
diff --git a/spec/lib/shared_client.rb b/spec/lib/shared_client.rb
@@ -1,10 +1,14 @@
 RSpec.shared_context "shared client" do
 
-  let(:app_id)        { "9QCM5C6Y2AX82M" }
-  let(:app_secret)    { "390db093ee6f71ffc6d488b9457593a7" }
-  let(:api_key)       { "XCNLJFG83URX95Y" }
-  let(:email)         { "[email protected]" }
-  let(:password)      { "badpassword" }
+  let(:app_id)        { "9Q444442AX82M" }
+  let(:app_secret)    { "390db09fc6672388b9457593a7" }
+  let(:api_key)       { "XCFDJKSFLNL5Y" }
+  let(:email)         { "[email protected]" }
+  let(:password)      { "password" }
+
+  #let(:email)         { "[email protected]" }
+  #let(:password)      { "badpassword" }
+
 
   let(:credentials) do  
     Echochamber::Credentials.new(app_id, app_secret, api_key, email, password)