From 528e01c4fa2f62efaecc32998a6391d9d74106cb Mon Sep 17 00:00:00 2001 From: "C. Thomas" Date: Thu, 21 Aug 2014 05:14:38 -0500 Subject: [PATCH] Finish finessing the documentation --- Gemfile.lock | 2 +- README.md | 2 ++ doc/Echochamber.html | 4 ++-- doc/Echochamber/Agreement.html | 2 +- doc/Echochamber/Client.html | 2 +- doc/Echochamber/CounterSignerInfo.html | 2 +- doc/Echochamber/Credentials.html | 2 +- doc/Echochamber/Fileinfo.html | 2 +- doc/Echochamber/ParameterError.html | 2 +- doc/Echochamber/PhoneInfo.html | 2 +- doc/Echochamber/Recipient.html | 2 +- doc/Echochamber/RecipientSecurityOption.html | 2 +- doc/Echochamber/Reminder.html | 2 +- doc/Echochamber/Request.html | 2 +- doc/Echochamber/Request/Failure.html | 2 +- doc/Echochamber/RequiredParameterError.html | 2 +- doc/Echochamber/UrlFileInfo.html | 2 +- doc/Echochamber/User.html | 2 +- doc/Echochamber/Validatable.html | 2 +- doc/Echochamber/Widget.html | 2 +- doc/Echochamber/WidgetCompletionInfo.html | 2 +- doc/Echochamber/WidgetPersonalization.html | 2 +- doc/Echochamber/WidgetSecurityOption.html | 2 +- .../WidgetSignerSecurityOption.html | 2 +- doc/Echochamber/WidgetStatus.html | 2 +- doc/Echochamber/WidgetVaultingInfo.html | 2 +- doc/_index.html | 2 +- doc/file.README.html | 9 ++++++--- doc/index.html | 9 ++++++--- doc/top-level-namespace.html | 2 +- echochamber.gemspec | 4 ++-- fixtures/vcr_cassettes/get_token.yml | 2 +- lib/echochamber/version.rb | 2 +- spec/lib/client_spec.rb | 4 ---- spec/lib/request_spec.rb | 20 ++----------------- spec/lib/shared_client.rb | 14 ++++++++----- spec/lib/widget/client_spec.rb | 2 +- 37 files changed, 58 insertions(+), 66 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 6c24d18..35f7245 100644 --- 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 index 1866d8a..bc752a7 100644 --- 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 index 9216d3a..cd9922e 100644 --- a/doc/Echochamber.html +++ b/doc/Echochamber.html @@ -106,7 +106,7 @@

Constant Summary

VERSION =
- 
"0.0.1"
+ 
"1.0.0"
@@ -122,7 +122,7 @@

Constant Summary

diff --git a/doc/Echochamber/Agreement.html b/doc/Echochamber/Agreement.html index 05762eb..3c7c2b4 100644 --- a/doc/Echochamber/Agreement.html +++ b/doc/Echochamber/Agreement.html @@ -520,7 +520,7 @@

diff --git a/doc/Echochamber/Client.html b/doc/Echochamber/Client.html index f141f51..d1eb6e7 100644 --- a/doc/Echochamber/Client.html +++ b/doc/Echochamber/Client.html @@ -4152,7 +4152,7 @@

diff --git a/doc/Echochamber/CounterSignerInfo.html b/doc/Echochamber/CounterSignerInfo.html index 2bb0720..1bd5d39 100644 --- a/doc/Echochamber/CounterSignerInfo.html +++ b/doc/Echochamber/CounterSignerInfo.html @@ -256,7 +256,7 @@

diff --git a/doc/Echochamber/Credentials.html b/doc/Echochamber/Credentials.html index ea69b82..e80dcf2 100644 --- a/doc/Echochamber/Credentials.html +++ b/doc/Echochamber/Credentials.html @@ -321,7 +321,7 @@

diff --git a/doc/Echochamber/Fileinfo.html b/doc/Echochamber/Fileinfo.html index 8ac3c2d..e839082 100644 --- a/doc/Echochamber/Fileinfo.html +++ b/doc/Echochamber/Fileinfo.html @@ -294,7 +294,7 @@

diff --git a/doc/Echochamber/ParameterError.html b/doc/Echochamber/ParameterError.html index 3acacce..cd2b834 100644 --- a/doc/Echochamber/ParameterError.html +++ b/doc/Echochamber/ParameterError.html @@ -114,7 +114,7 @@ diff --git a/doc/Echochamber/PhoneInfo.html b/doc/Echochamber/PhoneInfo.html index c51beef..2a825bc 100644 --- a/doc/Echochamber/PhoneInfo.html +++ b/doc/Echochamber/PhoneInfo.html @@ -270,7 +270,7 @@

diff --git a/doc/Echochamber/Recipient.html b/doc/Echochamber/Recipient.html index 6bbfa98..5e57fd9 100644 --- a/doc/Echochamber/Recipient.html +++ b/doc/Echochamber/Recipient.html @@ -300,7 +300,7 @@

diff --git a/doc/Echochamber/RecipientSecurityOption.html b/doc/Echochamber/RecipientSecurityOption.html index 6b88539..725ad2a 100644 --- a/doc/Echochamber/RecipientSecurityOption.html +++ b/doc/Echochamber/RecipientSecurityOption.html @@ -285,7 +285,7 @@

diff --git a/doc/Echochamber/Reminder.html b/doc/Echochamber/Reminder.html index b2dd3cf..46d269f 100644 --- a/doc/Echochamber/Reminder.html +++ b/doc/Echochamber/Reminder.html @@ -268,7 +268,7 @@

diff --git a/doc/Echochamber/Request.html b/doc/Echochamber/Request.html index fbfd67a..a926799 100644 --- a/doc/Echochamber/Request.html +++ b/doc/Echochamber/Request.html @@ -4158,7 +4158,7 @@

diff --git a/doc/Echochamber/Request/Failure.html b/doc/Echochamber/Request/Failure.html index 345b0c6..ae78a0e 100644 --- a/doc/Echochamber/Request/Failure.html +++ b/doc/Echochamber/Request/Failure.html @@ -114,7 +114,7 @@ diff --git a/doc/Echochamber/RequiredParameterError.html b/doc/Echochamber/RequiredParameterError.html index bc9befa..a1cae16 100644 --- a/doc/Echochamber/RequiredParameterError.html +++ b/doc/Echochamber/RequiredParameterError.html @@ -114,7 +114,7 @@ diff --git a/doc/Echochamber/UrlFileInfo.html b/doc/Echochamber/UrlFileInfo.html index 3ef218c..86ad162 100644 --- a/doc/Echochamber/UrlFileInfo.html +++ b/doc/Echochamber/UrlFileInfo.html @@ -286,7 +286,7 @@

diff --git a/doc/Echochamber/User.html b/doc/Echochamber/User.html index 06db057..4d91e03 100644 --- a/doc/Echochamber/User.html +++ b/doc/Echochamber/User.html @@ -411,7 +411,7 @@

diff --git a/doc/Echochamber/Validatable.html b/doc/Echochamber/Validatable.html index 009c074..1ebf475 100644 --- a/doc/Echochamber/Validatable.html +++ b/doc/Echochamber/Validatable.html @@ -346,7 +346,7 @@

diff --git a/doc/Echochamber/Widget.html b/doc/Echochamber/Widget.html index 4ae3681..e4341ca 100644 --- a/doc/Echochamber/Widget.html +++ b/doc/Echochamber/Widget.html @@ -645,7 +645,7 @@

diff --git a/doc/Echochamber/WidgetCompletionInfo.html b/doc/Echochamber/WidgetCompletionInfo.html index 229ffc7..e1865d5 100644 --- a/doc/Echochamber/WidgetCompletionInfo.html +++ b/doc/Echochamber/WidgetCompletionInfo.html @@ -300,7 +300,7 @@

diff --git a/doc/Echochamber/WidgetPersonalization.html b/doc/Echochamber/WidgetPersonalization.html index 15149e3..54d358f 100644 --- a/doc/Echochamber/WidgetPersonalization.html +++ b/doc/Echochamber/WidgetPersonalization.html @@ -317,7 +317,7 @@

diff --git a/doc/Echochamber/WidgetSecurityOption.html b/doc/Echochamber/WidgetSecurityOption.html index f9a5fe5..75937ff 100644 --- a/doc/Echochamber/WidgetSecurityOption.html +++ b/doc/Echochamber/WidgetSecurityOption.html @@ -350,7 +350,7 @@

diff --git a/doc/Echochamber/WidgetSignerSecurityOption.html b/doc/Echochamber/WidgetSignerSecurityOption.html index 085023c..4a5d0a9 100644 --- a/doc/Echochamber/WidgetSignerSecurityOption.html +++ b/doc/Echochamber/WidgetSignerSecurityOption.html @@ -287,7 +287,7 @@

diff --git a/doc/Echochamber/WidgetStatus.html b/doc/Echochamber/WidgetStatus.html index b1c5aaa..ce8c408 100644 --- a/doc/Echochamber/WidgetStatus.html +++ b/doc/Echochamber/WidgetStatus.html @@ -305,7 +305,7 @@

diff --git a/doc/Echochamber/WidgetVaultingInfo.html b/doc/Echochamber/WidgetVaultingInfo.html index 72fee59..4a3d5a6 100644 --- a/doc/Echochamber/WidgetVaultingInfo.html +++ b/doc/Echochamber/WidgetVaultingInfo.html @@ -256,7 +256,7 @@

diff --git a/doc/_index.html b/doc/_index.html index 603b054..fcda43a 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -329,7 +329,7 @@

Namespace Listing A-Z

diff --git a/doc/file.README.html b/doc/file.README.html index 1aea0ff..c7cb4df 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -89,9 +89,12 @@

Usage

Initializing a client

-
credentials = Echochamber::Credentials.new(app_id, app_secret, api_key, email, password)
+
require 'echochamber'
 
-client = Echochamber::Client.new(credentials)

+credentials = Echochamber::Credentials.new(app_id, app_secret, api_key, email, password)
+
+client = Echochamber::Client.new(credentials)
+

Setting up a new agreement from a URL

@@ -145,7 +148,7 @@

Sending a transie diff --git a/doc/index.html b/doc/index.html index 1aea0ff..c7cb4df 100644 --- a/doc/index.html +++ b/doc/index.html @@ -89,9 +89,12 @@

Usage

Initializing a client

-
credentials = Echochamber::Credentials.new(app_id, app_secret, api_key, email, password)
+
require 'echochamber'
 
-client = Echochamber::Client.new(credentials)

+credentials = Echochamber::Credentials.new(app_id, app_secret, api_key, email, password)
+
+client = Echochamber::Client.new(credentials)
+

Setting up a new agreement from a URL

@@ -145,7 +148,7 @@

Sending a transie diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html index 9c4682a..c8dc11f 100644 --- a/doc/top-level-namespace.html +++ b/doc/top-level-namespace.html @@ -103,7 +103,7 @@

Defined Under Namespace

diff --git a/echochamber.gemspec b/echochamber.gemspec index d65bb72..b80f9e5 100644 --- 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 index 43bebae..f15bd36 100644 --- a/fixtures/vcr_cassettes/get_token.yml +++ b/fixtures/vcr_cassettes/get_token.yml @@ -5,7 +5,7 @@ http_interactions: uri: https://secure.echosign.com/api/rest/v2/auth/tokens body: encoding: UTF-8 - string: '{"applicationCredentials":{"applicationId":"9QCM5C6Y2AX82M","applicationSecret":"390db093ee6f71ffc6d488b9457593a7"},"userCredentials":{"apiKey":"XCNLJFG83URX95Y","email":"cthomas@railjumper.com","password":"vvidmk"}}' + string: '{"applicationCredentials":{"applicationId":"9QC4444Y2AX82M","applicationSecret":"39066666ee6f71ffc6d488b9457593a7"},"userCredentials":{"apiKey":"XCNUUUUU3URX95Y","email":"cthomas@railjumper.com","password":"dfddkk"}}' headers: Accept: - application/json diff --git a/lib/echochamber/version.rb b/lib/echochamber/version.rb index 5f50a67..7dca29d 100644 --- 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 index 311d707..cd11337 100644 --- 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 index 9f9fa03..f51b128 100644 --- 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) { "cthomas@railjumper.com" } - 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 index 0b0ccf8..5430ee2 100644 --- 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) { "cthomas@railjumper.com" } - let(:password) { "badpassword" } + let(:app_id) { "9Q444442AX82M" } + let(:app_secret) { "390db09fc6672388b9457593a7" } + let(:api_key) { "XCFDJKSFLNL5Y" } + let(:email) { "nobody@nobody.com" } + let(:password) { "password" } + + #let(:email) { "cthomas@railjumper.com" } + #let(:password) { "badpassword" } + let(:credentials) do Echochamber::Credentials.new(app_id, app_secret, api_key, email, password) diff --git a/spec/lib/widget/client_spec.rb b/spec/lib/widget/client_spec.rb index a6ccd89..8f18a54 100644 --- a/spec/lib/widget/client_spec.rb +++ b/spec/lib/widget/client_spec.rb @@ -102,7 +102,7 @@ end end - describe '.get_widget_documents' do + describe '.get_widget_document_file' do let(:widget_id) { "2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*" } let(:document_id) { "2AAABLblqZhCGyGn1bpbXp-Kt-QXX8fsBWhjjO-bUKd0NQ184Xxm-mE6gg0DN0e-3k0Lwj6IPw9Q*" }