echochamber 1.0.1

data/lib/echochamber/widget/widget_security_option.rb

@@ -0,0 +1,22 @@
+module Echochamber
+  class WidgetSecurityOption < Hash
+
+    include Validatable
+
+    # Widget initialization object
+    # 
+    # @param [Hash] params SYMBOL-referenced Hash containing:
+    # @option params [String] :passwordProtection 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
+    # @option params [String] :kbaProtection 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
+    # @option params [String] :webIdentityProtection 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 
+    # @option params [Boolean] :protectOpen 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
+    # @option params [String] :internalPassword 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
+    # @option params [String] :externalPassword 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
+    # @option params [String] :openPassword 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
+    def initialize(params)
+      merge!(params)
+    end
+
+  end
+end
+

data/lib/echochamber/widget/widget_signer_security_option.rb

@@ -0,0 +1,18 @@
+module Echochamber
+  class WidgetSignerSecurityOption < Hash
+
+    include Validatable
+
+    # Initialization object
+    # 
+    # @param [Hash] params SYMBOL-referenced Hash containing: 
+    # @option params [String] :authenticationMethod ['INHERITED_FROM_DOCUMENT' or 'KBA' or 'PASSWORD' or 'WEB_IDENTITY' or 'PHONE' or 'NONE']: 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
+    # @option params [String] :password The password required for the recipient to view and sign the widget
+    # @option params [Array] :phoneInfos 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
+    def initialize(params)
+      require_keys([:authenticationMethod], params)
+      merge!(params)
+    end
+
+  end
+end

data/lib/echochamber/widget/widget_status.rb

@@ -0,0 +1,20 @@
+module Echochamber
+  class WidgetStatus< Hash
+
+    include Validatable
+
+    # Status object 
+    # 
+    # @option [Hash] params
+    # @option params [String] :value The status to which the widget is to be updated. The possible values for this variable are ENABLE and DISABLE (REQUIRED)
+    # @option params [String] :message Display this custom message to the user when the widget is accessed. Note that this can contain wiki markup to include clickable links in the message. This is required if redirectUrl is not provided. Both message and redirectUrl can not be specified
+    # @option params [String] :redirectUrl Redirect the user to this URL when the widget is accessed. This is required if message is not provided. Both message and redirectUrl can not be specified
+    # @return [Echochamber::WidgetStatus]
+    def initialize(params)
+      require_keys([:value], params)
+      require_exactly_one([:message, :redirectUrl], params)
+      merge!(params)
+    end
+
+  end
+end

data/lib/echochamber/widget/widget_vaulting_info.rb

@@ -0,0 +1,16 @@
+module Echochamber
+  class WidgetVaultingInfo < Hash
+
+    include Validatable
+
+    # Initialization object
+    # 
+    # @param [Hash] params SYMBOL-referenced Hash containing: 
+    # @option params [Boolean] :enabled For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted
+    def initialize(params)
+      require_keys([:enabled], params)
+      merge!(params)
+    end
+
+  end
+end

data/spec/lib/agreement/client_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+require 'lib/shared_client.rb'
+
+describe Echochamber::Client do
+  include_context "shared client"
+
+  describe '.create_agreement' do
+
+    let(:url_file_info) do
+      {
+      url: 'http://findgoplayers.com/resume.pdf',
+      mimeType: 'application/pdf',
+      name: 'resume.pdf'
+      }
+    end
+
+    let(:file_info) do
+      { 
+        documentURL: Echochamber::UrlFileInfo.new(url_file_info) 
+      }
+    end
+
+    let(:file_infos) do
+      [ Echochamber::Fileinfo.new(file_info) ] 
+    end
+
+    let(:agreement_user_id) { nil } 
+    let(:agreement_user_email) { nil }
+
+    let(:agreement_info) do
+      {
+        fileInfos: [ file_infos ],
+        recipients: [ Echochamber::Recipient.new({ role: 'SIGNER', email: 'goishi.san@gmail.com'})],
+        signatureFlow: "SENDER_SIGNS_LAST",
+        signatureType: "ESIGN",
+        name: "Rumplestiltskin Contract"
+      }
+    end
+
+    let(:agreement)  { Echochamber::Agreement.new(agreement_user_id, agreement_user_email, agreement_info) }
+
+    it 'returns the agreement_id' do
+      VCR.use_cassette('create_agreement', :record => :once) do
+        agreement_id = client.create_agreement(agreement)
+        expect(agreement_id).to_not be_nil
+      end
+    end
+  end
+
+  describe '.get_agreements' do
+    it 'returns all agreements' do
+      VCR.use_cassette('get_agreements', :record => :once) do
+        response = client.get_agreements
+        expect(response).to_not be_nil
+      end
+    end
+  end
+
+  describe '.agreement_info' do
+    let(:agreement_id) { "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*" }
+    it 'returns detailed agreement info' do
+      VCR.use_cassette('agreement_info', :record => :once) do
+        response = client.agreement_info(agreement_id)
+        expect(response).to_not be_nil
+      end
+    end
+  end
+
+  describe '.agreement_form_data' do
+   let(:agreement_id) { "2AAABLblqZhDvfdYluvps8mSzQXnXr074OVtMYTwTVtljZYFJNi43iuzYeBaPUUOMTSlGXrt04Sw*" }
+    it 'returns CSV data' do
+      VCR.use_cassette('agreement_form_data', :record => :once) do
+        response = client.agreement_form_data(agreement_id)
+        expect(response).to_not be_nil
+      end
+   end
+  end
+
+  describe '.cancel_agreement' do
+    let(:agreement_id) { "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*" }
+
+    it 'returns the result of the operation' do
+      VCR.use_cassette('cancel_agreement', :record => :once) do
+        result = client.cancel_agreement(agreement_id, true, 'Just because')
+        expect(result).to_not be_nil
+      end
+    end
+  end
+
+  describe '.agreement_documents' do
+    let(:agreement_id) { "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*" }
+    let(:recipient_email) { 'goishi.san@gmail.com' }
+    let(:format) { 'CONVERTED_PDF' }
+    let(:version_id) { nil }
+
+    it 'returns information about documents for this agreement' do
+      VCR.use_cassette('agreement_documents', :record => :once) do
+        result = client.agreement_documents(agreement_id, recipient_email, format, version_id)
+        expect(result).to_not be_nil
+      end
+    end
+  end
+
+  describe '.agreement_document_file' do
+    let(:agreement_id) { "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*" }
+    let(:document_id) { "2AAABLblqZhDcteEO9jy6gSat9d_3XgpPVpxhetoDCpU4L9PoolGv_3mqgKL1DhIGTXTHhqAHlHk*" }
+
+    it 'returns a document file from the selected agreement' do
+      VCR.use_cassette('agreement_document_file', :record => :once) do
+        result = client.agreement_document_file(agreement_id, document_id)
+        expect(result).to be_a String 
+        expect(result).to_not be_nil
+      end
+    end
+  end
+
+  describe '.audit_trail_pdf' do
+    let(:agreement_id) { "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*" }
+
+    it 'returns a pdf file for an audit trail on the agreement' do
+      VCR.use_cassette('audit_trail_pdf', :record => :once) do
+        result = client.audit_trail_pdf(agreement_id)
+        expect(result).to be_a String 
+        expect(result).to_not be_nil
+      end
+    end
+  end
+
+  describe '.agreement_combined_pdf' do
+    let(:agreement_id) { "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*" }
+
+    it 'returns a combined pdf file ' do
+      VCR.use_cassette('agreement_combined_pdf', :record => :once) do
+        result = client.agreement_combined_pdf(agreement_id)
+        expect(result).to be_a String 
+        expect(result).to_not be_nil
+      end
+    end
+  end
+
+  describe '.agreement_signing_urls' do
+    let(:agreement_id) { "2AAABLblqZhDdfTP0uM4EIz2UE2Mq27D7PXGl7Uk3e5nO4RtzlkN8GMANmeVwUVRWGGuUGCQoRQc*" }
+
+    it 'returns URL information for the agreement' do
+      VCR.use_cassette('agreement_signing_urls', :record => :once) do
+        result = client.agreement_signing_urls(agreement_id)
+        expect(result).to be_a Hash
+      end
+    end
+  end
+
+
+
+end
+ 
+

data/spec/lib/client_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+require 'lib/shared_client.rb'
+
+describe Echochamber::Client do
+  include_context "shared client"
+
+  describe '.create_user' do
+    let (:user_params) do
+      {
+        firstName:  'JohnQ',
+        lastName:   'Public',
+        email:      'publius@comcast.net',
+        password:   'kN12oK9p!3',
+        title:      'Hedge Wizard'
+      }
+    end
+    let (:user) { Echochamber::User.new(user_params) }
+
+    it 'returns the User ID' do
+      VCR.use_cassette('create_user', :record => :once) do
+        user_id = client.create_user(user)
+        expect(user_id).to_not be_nil
+      end
+    end
+  end
+
+  describe '.get_users' do
+   let(:email) { "cthomas@railjumper.com" }
+    it 'returns user data' do
+      VCR.use_cassette('get_users', :record => :once) do
+        response = client.get_users(email)
+        expect(response).to be_a Hash
+      end
+   end
+  end
+
+  describe '.get_user' do
+   let(:id) { "2AAABLblqZhBp6sZ412RCo4_5P1OCDATcuKQf3gzb7M-kea77rqC7h6kzMKSpofswP8rY9Cwv9Vw*" }
+    it 'returns user data' do
+      VCR.use_cassette('get_user', :record => :once) do
+        response = client.get_user(id)
+        expect(response).to be_a Hash
+      end
+   end
+  end
+
+  describe '.create_reminder' do
+    let(:reminderInfo) { { 
+        agreementId: "2AAABLblqZhA79nM-6ALjW2nXMKKb_ECz-Nr2yr_WrJ-3-Vz7d5D5_Dn9B6K-25C_EDktQqawW7M*", 
+        comment: "Hey don't forget..." 
+    } }
+    let(:reminder) { Echochamber::Reminder.new(reminderInfo) }
+
+    it 'returns result'  do
+      VCR.use_cassette('create_reminder', :record => :once) do
+        response = client.create_reminder(reminder)
+        expect(response).to be_a Hash
+      end
+    end
+  end
+
+  describe '.create_transient_document' do
+    let(:file_name) { 'agreement.pdf' }
+    let(:mime_type) { 'application/pdf' }
+    let(:file) { File.new("fixtures/agreement.pdf", 'rb') }
+
+    it 'returns the transient document ID' do
+      VCR.use_cassette('create_transient_document', :record => :once) do
+        tran_doc_id = client.create_transient_document(file_name, mime_type, file)
+        expect(tran_doc_id).to_not be_nil
+      end
+    end
+  end
+
+
+end # describe Echochamber::Client
+
+

data/spec/lib/library_documents/client_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Echochamber::Client do
+  include_context "shared client"
+
+  describe '.get_library_documents' do
+    let(:user_id) { nil }
+    let(:user_email) { 'cthomas@railjumper.com' }
+    it 'returns info about library documents' do
+      VCR.use_cassette('get_library_documents', :record => :once) do
+        response = client.get_library_documents(user_id, user_email)
+        expect(response).to be_a Hash
+      end
+    end
+  end
+
+  describe '.get_library_document' do
+    let(:library_document_id) {"2AAABLblqZhCri9FNiCHjwsixnFegzTxO6cP52B-FIhfOXZjjDHggZoYPQB5r0YS66QZg4DLQV-g*"}
+    it 'returns info about library document' do
+      VCR.use_cassette('get_library_document', :record => :once) do
+        response = client.get_library_document(library_document_id)
+        expect(response).to be_a Hash
+      end
+    end
+  end
+
+  describe '.get_library_document_files' do
+    let(:library_document_id) {"2AAABLblqZhAlC4t0c3xAJ92RFv44xFGZhbCuHpalUdpcHW9k72imMEG-W1SYCmUoia1ZNgQZ-FE*"}
+    it 'returns info about library document files' do
+      VCR.use_cassette('get_library_document_file', :record => :once) do
+        response = client.get_library_document_files(library_document_id)
+        expect(response).to be_a Hash
+      end
+    end
+  end
+
+  describe '.get_library_document_file' do
+    let(:library_document_id) { "2AAABLblqZhAlC4t0c3xAJ92RFv44xFGZhbCuHpalUdpcHW9k72imMEG-W1SYCmUoia1ZNgQZ-FE*" }
+    let(:file_id) { "2AAABLblqZhD0YJu7EaQ3t2aKYe74spEGcgIXHeloWBdhkceuEbfqs9cw0pdkFB6z3RR4N8OWkZg*" }
+    it 'returns library document file data' do
+      VCR.use_cassette('get_library_document_data', :record => :once) do
+        response = client.get_library_document_file(library_document_id, file_id)
+        expect(response).to_not be_nil 
+      end
+    end
+  end
+
+  describe '.library_document_audit_trail' do
+    let(:library_document_id) { "2AAABLblqZhAlC4t0c3xAJ92RFv44xFGZhbCuHpalUdpcHW9k72imMEG-W1SYCmUoia1ZNgQZ-FE*" }
+    it 'returns library document file data' do
+      VCR.use_cassette('library_document_audit_trail', :record => :once) do
+        response = client.library_document_audit_trail(library_document_id)
+        expect(response).to_not be_nil 
+      end
+    end
+  end
+
+  describe '.library_combined_document' do
+    let(:library_document_id) { "2AAABLblqZhAlC4t0c3xAJ92RFv44xFGZhbCuHpalUdpcHW9k72imMEG-W1SYCmUoia1ZNgQZ-FE*" }
+    it 'returns library combined document file data' do
+      VCR.use_cassette('library_combined_document', :record => :once) do
+        response = client.library_combined_document(library_document_id, nil, true)
+        expect(response).to_not be_nil 
+      end
+    end
+  end
+
+
+
+end
+

data/spec/lib/request_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'lib/shared_client.rb'
+
+describe Echochamber::Request do
+  include_context "shared client"
+
+  describe '#get_token' do
+
+      it 'returns the accessToken' do
+        VCR.use_cassette('get_token', :record => :once) do
+          token = Echochamber::Request.get_token(credentials)
+          expect(token).to_not be_nil
+        end
+      end
+
+  end
+
+end

data/spec/lib/shared_client.rb

@@ -0,0 +1,22 @@
+RSpec.shared_context "shared client" do
+
+  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)
+  end
+
+  let(:client) do
+    VCR.use_cassette('get_token', :record => :once) do
+      Echochamber::Client.new(credentials) 
+    end
+  end
+end

data/spec/lib/user_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Echochamber::User do
+
+end
+ 

data/spec/lib/validatable_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+require 'echochamber/validatable'
+
+describe Echochamber::Validatable do
+
+  let(:first_name)  { "John" }
+  let(:last_name)   { "Public" }
+
+  let(:params) do
+    {
+      firstName:   first_name,
+      lastName:    last_name,
+      phone:       "885551234" 
+    }
+  end
+
+  let(:validatable_object) do
+    class Foo 
+      include Echochamber::Validatable  
+    end
+    Foo.new
+  end 
+
+  describe ".validate_field" do
+
+    context "when field is nil" do
+      let(:first_name) { nil }
+
+      it "raises an invalid parameter error" do
+        expect do 
+          validatable_object.validate_field(first_name, params)
+        end.to raise_error(Echochamber::RequiredParameterError)
+      end
+    end
+
+    context "when field is empty" do
+      let(:first_name) { '' }
+
+      it "raises an invalid parameter error" do
+        expect do 
+          validatable_object.validate_field(first_name, params)
+        end.to raise_error(Echochamber::RequiredParameterError)
+      end
+
+    end
+
+    context "when key is not present" do
+      it "raises an invalid parameter error" do
+        expect do 
+          validatable_object.validate_field([:unknown_field], params)
+        end.to raise_error(Echochamber::RequiredParameterError)
+      end
+    end
+
+  end
+
+  describe '.require_keys' do
+    let(:required_fields) do
+      [
+        :firstName,
+        :lastName
+      ]
+    end
+
+    context 'when all required fields are present' do
+      it 'it does not raise an error' do
+        expect do 
+          validatable_object.require_keys(required_fields, params)
+        end.to_not raise_error
+      end
+    end
+
+    context 'when a required field is not present' do
+      it 'it raises an error' do
+        expect do 
+          validatable_object.require_keys(required_fields.push(:unknown_field), params)
+        end.to raise_error(Echochamber::RequiredParameterError)
+      end
+    end
+  end
+
+  describe '.require_exactly_one' do
+    context 'when more than one key value is present' do
+      it 'it raises an error' do
+        expect do 
+          validatable_object.require_exactly_one([:firstName, :lastName], params)
+        end.to raise_error(Echochamber::ParameterError)
+      end
+    end
+
+    context 'when none of the key values are present' do
+      it 'it raises an error' do
+        expect do 
+          validatable_object.require_exactly_one([:unknown_field], params)
+        end.to raise_error(Echochamber::ParameterError)
+      end
+    end
+
+    context 'when exactly one of the key values is present' do
+      it 'it does not raise an error' do
+        expect do 
+          validatable_object.require_exactly_one([:firstName], params)
+        end.to_not raise_error
+      end
+    end
+
+  end
+
+end