echosign 1.0.2

data/spec/lib/client_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+require 'lib/shared_client.rb'
+
+describe Echosign::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) { Echosign::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) { Echosign::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 Echosign::Client
+
+

data/spec/lib/library_documents/client_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Echosign::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 Echosign::Request do
+  include_context "shared client"
+
+  describe '#get_token' do
+
+      it 'returns the accessToken' do
+        VCR.use_cassette('get_token', :record => :once) do
+          token = Echosign::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  
+    Echosign::Credentials.new(app_id, app_secret, api_key, email, password)
+  end
+
+  let(:client) do
+    VCR.use_cassette('get_token', :record => :once) do
+      Echosign::Client.new(credentials) 
+    end
+  end
+end

data/spec/lib/user_spec.rb

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

data/spec/lib/validatable_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+require 'echosign/validatable'
+
+describe Echosign::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 Echosign::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(Echosign::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(Echosign::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(Echosign::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(Echosign::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(Echosign::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(Echosign::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

data/spec/lib/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Echosign do
+  it 'returns a version string' do
+    expect(Echosign::VERSION).to be_a String 
+  end
+end

data/spec/lib/widget/client_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+describe Echosign::Client do
+  include_context "shared client"
+
+  describe '.create_widget' do
+
+    let(:url_file_info_params) do
+      {
+        url: 'http://findgoplayers.com/resume.pdf',
+        mimeType: 'application/pdf',
+        name: 'resume.pdf'
+      }
+    end
+
+    let(:file_info_params) do
+      { 
+        documentURL: Echosign::UrlFileInfo.new(url_file_info_params) 
+      }
+    end
+
+    let(:widget_params) do
+      {
+        signatureFlow: 'SENDER_SIGNS_LAST',
+        fileInfos: [ Echosign::Fileinfo.new(file_info_params) ],
+        name: 'Test widget'
+      }
+    end 
+
+    let(:widget) { Echosign::Widget.new(nil, nil, widget_params) }
+
+    it 'returns widget info' do
+      VCR.use_cassette('create_widget', :record => :once) do
+        widget_response = client.create_widget(widget)
+        expect(widget_response).to be_a Hash
+      end
+    end
+  end
+
+  describe '.personalize_widget' do
+    let(:widget_id) { "2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*" }
+    let(:personalization_params) do
+      {
+        email: "cthomas@railjumper.com"
+      }
+    end
+    let(:personalization) { Echosign::WidgetPersonalization.new(personalization_params) }
+
+    it 'returns widget info' do
+      VCR.use_cassette('personalize_widget', :record => :once) do
+        widget_response = client.personalize_widget(widget_id, personalization)
+        expect(widget_response).to be_a Hash
+      end
+    end
+  end
+
+  describe '.update_widget_status' do
+    let(:widget_id) { "2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*" }
+    let(:status_params) do
+      {
+        value: 'ENABLE',
+        message: 'Hey guys, hope you like this widget.'
+      }
+    end
+    let(:status) { Echosign::WidgetStatus.new(status_params) }
+
+    it 'returns widget info' do
+      VCR.use_cassette('update_widget_status', :record => :once) do
+        widget_response = client.update_widget_status(widget_id, status)
+        expect(widget_response).to be_a Hash
+      end
+    end
+  end
+
+  describe '.get_widgets' do
+    it 'returns widgets info' do
+      VCR.use_cassette('get_widgets', :record => :once) do
+        widget_response = client.get_widgets
+        expect(widget_response).to be_a Hash
+      end
+    end
+  end
+
+  describe '.get_widget' do
+    let(:widget_id) { "2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*" }
+    it 'returns widget info' do
+      VCR.use_cassette('get_widget', :record => :once) do
+        widget_response = client.get_widget(widget_id)
+        expect(widget_response).to be_a Hash
+      end
+    end
+  end
+
+  describe '.get_widget_documents' do
+    let(:widget_id) { "2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*" }
+
+    it 'returns widget documents info' do
+      VCR.use_cassette('get_widget_documents', :record => :once) do
+        widget_response = client.get_widget_documents(widget_id)
+        expect(widget_response).to be_a Hash
+      end
+    end
+  end
+
+  describe '.get_widget_document_file' do
+    let(:widget_id) { "2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*" }
+    let(:document_id) { "2AAABLblqZhCGyGn1bpbXp-Kt-QXX8fsBWhjjO-bUKd0NQ184Xxm-mE6gg0DN0e-3k0Lwj6IPw9Q*" }
+
+    it 'returns widget document file' do
+      VCR.use_cassette('get_widget_document_file', :record => :once) do
+        widget_response = client.get_widget_document_file(widget_id, document_id)
+        expect(widget_response).to_not be_nil
+      end
+    end
+  end
+
+#  describe '.get_widget_audit_trail' do
+#    let(:widget_id) { "2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*" }
+
+#    it 'returns widget document file' do
+#      VCR.use_cassette('get_widget_audit_trail', :record => :once) do
+#        widget_response = client.get_widget_audit_trail(widget_id)
+#        binding.pry
+#        expect(widget_response).to_not be_nil
+#      end
+#    end
+#  end
+
+#  describe '.get_widget_combined_pdf' do
+#    let(:widget_id) { "2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*" }
+
+#    it 'returns widget document file' do
+#      VCR.use_cassette('get_widget_combined_pdf', :record => :once) do
+#        widget_response = client.get_widget_combined_pdf(widget_id)
+#        binding.pry
+#        expect(widget_response).to_not be_nil
+#      end
+#    end
+#  end
+
+#  describe '.get_widget_form_data' do
+#    let(:widget_id) { "2AAABLblqZhD_6RpgbZh5ZVlLXz1H1kfVzw4vHB91MtmjNHBDorFqO0H3_cGzBudZxiWNzPXFzOc*" }
+
+#    it 'returns widget document file' do
+#      VCR.use_cassette('get_widget_form_data', :record => :once) do
+#        widget_response = client.get_widget_form_data(widget_id)
+#        binding.pry
+#        expect(widget_response).to_not be_nil
+#      end
+#    end
+#  end
+
+
+end