finapps 5.0.33 → 5.0.41

data/spec/rest/documents_orders_notifications_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe FinApps::REST::DocumentsOrdersNotifications do
       end
     end
 
-    context 'for valid id' do
+    context 'with valid id' do
       let(:create) { subject.create(:valid_id) }
       let(:results) { create[RESULTS] }
       let(:error_messages) { create[ERROR_MESSAGES] }

data/spec/rest/documents_orders_spec.rb

@@ -98,7 +98,7 @@ RSpec.describe FinApps::REST::DocumentsOrders do
 
         it_behaves_like 'an API request'
         it_behaves_like 'a successful request'
-        it { expect(subject.first[:records]).not_to be_empty }
+        it { expect(list.first[:records]).not_to be_empty }
       end
 
       context 'when filtering by closed status ordes' do

data/spec/rest/documents_upload_types_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::DocumentsUploadTypes do
+  include SpecHelpers::Client
+  subject(:upload_types) { described_class.new(client).list }
+
+  let(:results) { upload_types[0] }
+
+  describe '#list' do
+    context 'when called' do
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('performs a get and returns the response') do
+        expect(results[0]).to have_key(:type)
+      end
+    end
+  end
+end

data/spec/rest/documents_uploads_spec.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::DocumentsUploads do
+  include SpecHelpers::Client
+
+  describe '#show' do
+    let(:upload) { described_class.new(client) }
+
+    context 'when missing doc id' do
+      subject(:show) { upload.show(:consumer_id, nil) }
+
+      it 'raises an error' do
+        expect { show }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+    end
+
+    context 'when missing consumer id' do
+      subject(:show) { upload.show(nil, :doc_id) }
+
+      it 'raises an error' do
+        expect { show }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+    end
+
+    context 'when thumbnail is not included' do
+      subject(:show) do
+        upload.show(
+          :consumer_id,
+          :doc_id
+        )
+      end
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+    end
+
+    context 'when thumbnail is included' do
+      subject(:show) do
+        upload.show(
+          :consumer_id,
+          :doc_id,
+          true
+        )
+      end
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+    end
+  end
+
+  describe '#destroy' do
+    subject(:destroy) { described_class.new(client).destroy(order_id, doc_id) }
+
+    let(:results) { destroy[0] }
+    let(:error_messages) { destroy[1] }
+
+    context 'with valid id' do
+      let(:order_id) { :valid_order_id }
+      let(:doc_id) { :valid_doc_id }
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('results is nil') { expect(results).to be_nil }
+    end
+
+    context 'with invalid order id' do
+      let(:order_id) { :invalid_order_id }
+      let(:doc_id) { :valid_doc_id }
+
+      it_behaves_like 'an API request'
+      it('results is nil') { expect(results).to be_nil }
+
+      it('error messages array is populated') do
+        expect(error_messages.first.downcase).to eq('resource not found')
+      end
+    end
+
+    context 'with invalid doc id' do
+      let(:order_id) { :valid_order_id }
+      let(:doc_id) { :invalid_doc_id }
+
+      it_behaves_like 'an API request'
+      it('results is nil') { expect(results).to be_nil }
+
+      it('error messages array is populated') do
+        expect(error_messages.first.downcase).to eq('resource not found')
+      end
+    end
+
+    context 'with missing id' do
+      let(:order_id) { nil }
+      let(:doc_id) { nil }
+
+      it do
+        expect { destroy }.to raise_error(
+          FinAppsCore::MissingArgumentsError
+        )
+      end
+    end
+  end
+end

data/spec/rest/operators_password_resets_spec.rb

@@ -2,84 +2,77 @@
 
 require 'spec_helpers/client'
 
-RSpec.describe FinApps::REST::OperatorsPasswordResets,
-               'initialized with valid FinApps::Client object' do
-  include SpecHelpers::Client
-  subject(:operators_password_resets) do
-    described_class.new(client)
-  end
+RSpec.describe FinApps::REST::OperatorsPasswordResets do
+  context 'when initialized with valid FinApps::Client object' do
+    include SpecHelpers::Client
+    subject(:operators_password_resets) do
+      described_class.new(client)
+    end
 
-  describe '#create' do
-    let(:results) { create[0] }
-    let(:error_messages) { create[1] }
+    describe '#create' do
+      let(:results) { create[0] }
+      let(:error_messages) { create[1] }
 
-    context 'when missing params' do
-      let(:create) { subject.create(nil) }
+      context 'when missing params' do
+        let(:create) { subject.create(nil) }
 
-      it do
-        expect { create }.to raise_error(FinAppsCore::MissingArgumentsError)
+        it do
+          expect { create }.to raise_error(FinAppsCore::MissingArgumentsError)
+        end
       end
-    end
 
-    context 'for invalid params' do
-      let(:create) { subject.create(params: 'invalid params') }
+      context 'with invalid params' do
+        let(:create) { subject.create(params: 'invalid params') }
 
-      it do
-        expect { create }.to raise_error(FinAppsCore::InvalidArgumentsError)
+        it do
+          expect { create }.to raise_error(FinAppsCore::InvalidArgumentsError)
+        end
       end
-    end
-
-    context 'for valid params' do
-      let(:create) { subject.create(email: 'valid email') }
 
-      it { expect { create }.not_to raise_error }
-      it('returns an array') { expect(create).to be_a(Array) }
+      context 'with valid params' do
+        let(:create) { subject.create(email: 'valid email') }
 
-      it('performs a post and returns the response') do
-        expect(results).to have_key(:public_id)
-        expect(results).to have_key(:token)
-        expect(results).to have_key(:expiry_date)
+        it { expect { create }.not_to raise_error }
+        it('returns an array') { expect(create).to be_a(Array) }
+        it { expect(results).to have_key(:public_id) }
+        it { expect(results).to have_key(:token) }
+        it { expect(results).to have_key(:expiry_date) }
+        it('returns no error messages') { expect(error_messages).to be_empty }
       end
-
-      it('returns no error messages') { expect(error_messages).to be_empty }
     end
-  end
 
-  describe '#update' do
-    let(:results) { update[0] }
-    let(:error_messages) { update[1] }
+    describe '#update' do
+      let(:results) { update[0] }
+      let(:error_messages) { update[1] }
 
-    context 'when missing params' do
-      let(:update) { subject.update(nil) }
+      context 'when missing params' do
+        let(:update) { subject.update(nil) }
 
-      it do
-        expect { update }.to raise_error(FinAppsCore::MissingArgumentsError)
+        it do
+          expect { update }.to raise_error(FinAppsCore::MissingArgumentsError)
+        end
       end
-    end
 
-    context 'for invalid params' do
-      let(:update) { subject.update(params: 'invalid') }
+      context 'with invalid params' do
+        let(:update) { subject.update(params: 'invalid') }
 
-      it { expect { update }.not_to raise_error }
-      it('results is nil') { expect(results).to be_nil }
+        it { expect { update }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
 
-      it('error messages array is populated') do
-        expect(error_messages.first.downcase).to eq('invalid request body')
+        it('error messages array is populated') do
+          expect(error_messages.first.downcase).to eq('invalid request body')
+        end
       end
-    end
 
-    context 'for valid params' do
-      let(:update) { subject.update(params: 'valid') }
+      context 'with valid params' do
+        let(:update) { subject.update(params: 'valid') }
 
-      it { expect { update }.not_to raise_error }
-      it('returns an array') { expect(update).to be_a(Array) }
-
-      it('performs a post and returns the response') do
-        expect(results).to have_key(:public_id)
-        expect(results).to have_key(:role)
+        it { expect { update }.not_to raise_error }
+        it('returns an array') { expect(update).to be_a(Array) }
+        it { expect(results).to have_key(:public_id) }
+        it { expect(results).to have_key(:role) }
+        it('returns no error messages') { expect(error_messages).to be_empty }
       end
-
-      it('returns no error messages') { expect(error_messages).to be_empty }
     end
   end
 end

data/spec/rest/operators_spec.rb

@@ -2,261 +2,250 @@
 
 require 'spec_helpers/client'
 
-RSpec.describe FinApps::REST::Operators,
-               'initialized with valid FinApps::Client object' do
-  include SpecHelpers::Client
-  subject(:operators) { described_class.new(client) }
+RSpec.describe FinApps::REST::Operators do
+  context 'when initialized with valid FinApps::Client object' do
+    include SpecHelpers::Client
+    subject(:operators) { described_class.new(client) }
 
-  describe '#list' do
-    let(:list) { subject.list(params) }
-    let(:results) { list[0] }
-    let(:error_messages) { list[1] }
+    describe '#list' do
+      let(:list) { subject.list(params) }
+      let(:results) { list[0] }
+      let(:error_messages) { list[1] }
 
-    context 'when missing params' do
-      let(:params) { nil }
+      context 'when missing params' do
+        let(:params) { nil }
 
-      it { expect { list }.not_to raise_error }
+        it { expect { list }.not_to raise_error }
 
-      it('performs a get and returns the response') do
-        expect(results).to have_key(:records)
-      end
-
-      it('returns an array of records') do
-        expect(results[:records]).to be_a(Array)
-      end
-
-      it('returns no error messages') { expect(error_messages).to be_empty }
-    end
+        it('performs a get and returns the response') do
+          expect(results).to have_key(:records)
+        end
 
-    context 'when invalid params are provided' do
-      let(:params) { ['invalid array'] }
+        it('returns an array of records') do
+          expect(results[:records]).to be_a(Array)
+        end
 
-      it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
-    end
-
-    context 'when including valid params' do
-      let(:params) do
-        {
-          page: 2,
-          sort: 'date_created',
-          requested: 25,
-          searchTerm: 'term',
-          role: 2
-        }
+        it('returns no error messages') { expect(error_messages).to be_empty }
       end
 
-      it { expect { list }.not_to raise_error }
+      context 'when invalid params are provided' do
+        let(:params) { ['invalid array'] }
 
-      it('performs a get and returns the response') do
-        expect(results).to have_key(:records)
+        it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
       end
 
-      it('returns an array of records') do
-        expect(results[:records]).to be_a(Array)
-      end
+      context 'when including valid params' do
+        let(:params) do
+          {
+            page: 2,
+            sort: 'date_created',
+            requested: 25,
+            searchTerm: 'term',
+            role: 2
+          }
+        end
 
-      it('returns no error messages') { expect(error_messages).to be_empty }
+        it { expect { list }.not_to raise_error }
 
-      it 'builds query and sends proper request' do
-        list
-        url =
-          "#{versioned_api_path}/operators?filter=%7B%22last_name%22:%22term%22," \
-            '%22role%22:2%7D&page=2&requested=25&sort=date_created'
-        expect(WebMock).to have_requested(:get, url)
-      end
-    end
-  end
+        it('performs a get and returns the response') do
+          expect(results).to have_key(:records)
+        end
 
-  describe '#show' do
-    let(:results) { show[0] }
-    let(:error_messages) { show[1] }
+        it('returns an array of records') do
+          expect(results[:records]).to be_a(Array)
+        end
 
-    context 'when missing id' do
-      let(:show) { subject.show(nil) }
+        it('returns no error messages') { expect(error_messages).to be_empty }
 
-      it { expect { show }.to raise_error(FinAppsCore::MissingArgumentsError) }
+        it 'builds query and sends proper request' do
+          list
+          url =
+            "#{versioned_api_path}/operators?filter=%7B%22last_name%22:%22term%22," \
+              '%22role%22:2%7D&page=2&requested=25&sort=date_created'
+          expect(WebMock).to have_requested(:get, url)
+        end
+      end
     end
 
-    context 'for invalid id' do
-      let(:show) { subject.show(:invalid_id) }
+    describe '#show' do
+      let(:results) { show[0] }
+      let(:error_messages) { show[1] }
 
-      it { expect { show }.not_to raise_error }
-      it('results is nil') { expect(results).to be_nil }
+      context 'when missing id' do
+        let(:show) { subject.show(nil) }
 
-      it('error messages array is populated') do
-        expect(error_messages.first.downcase).to eq('resource not found')
+        it { expect { show }.to raise_error(FinAppsCore::MissingArgumentsError) }
       end
-    end
 
-    context 'for valid id' do
-      let(:show) { subject.show(:valid_id) }
+      context 'with invalid id' do
+        let(:show) { subject.show(:invalid_id) }
 
-      it { expect { show }.not_to raise_error }
-      it('returns an array') { expect(show).to be_a(Array) }
+        it { expect { show }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
 
-      it('performs a get and returns the response') do
-        expect(results).to have_key(:public_id)
+        it('error messages array is populated') do
+          expect(error_messages.first.downcase).to eq('resource not found')
+        end
       end
 
-      it('returns no error messages') { expect(error_messages).to be_empty }
-    end
-  end
+      context 'with valid id' do
+        let(:show) { subject.show(:valid_id) }
 
-  describe '#create' do
-    let(:results) { create[0] }
-    let(:error_messages) { create[1] }
+        it { expect { show }.not_to raise_error }
+        it('returns an array') { expect(show).to be_a(Array) }
 
-    context 'when missing params' do
-      let(:create) { subject.create(nil) }
+        it('performs a get and returns the response') do
+          expect(results).to have_key(:public_id)
+        end
 
-      it do
-        expect { create }.to raise_error(FinAppsCore::MissingArgumentsError)
+        it('returns no error messages') { expect(error_messages).to be_empty }
       end
     end
 
-    context 'when invalid params are provided' do
-      let(:create) { subject.create(params: 'invalid') }
+    describe '#create' do
+      let(:results) { create[0] }
+      let(:error_messages) { create[1] }
 
-      it { expect { create }.not_to raise_error }
-      it('results is nil') { expect(results).to be_nil }
+      context 'when missing params' do
+        let(:create) { subject.create(nil) }
 
-      it('error messages array is populated') do
-        expect(error_messages.first.downcase).to eq('invalid request body')
+        it do
+          expect { create }.to raise_error(FinAppsCore::MissingArgumentsError)
+        end
       end
-    end
 
-    context 'when valid params are provided' do
-      let(:create) { subject.create(params: 'valid') }
+      context 'when invalid params are provided' do
+        let(:create) { subject.create(params: 'invalid') }
 
-      it { expect { create }.not_to raise_error }
-      it('returns an array') { expect(create).to be_a(Array) }
+        it { expect { create }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
 
-      it('performs a post and returns the response') do
-        expect(results).to have_key(:public_id)
-        expect(results).to have_key(:role)
+        it('error messages array is populated') do
+          expect(error_messages.first.downcase).to eq('invalid request body')
+        end
       end
 
-      it('returns no error messages') { expect(error_messages).to be_empty }
+      context 'when valid params are provided' do
+        let(:create) { subject.create(params: 'valid') }
+
+        it { expect { create }.not_to raise_error }
+        it('returns an array') { expect(create).to be_a(Array) }
+        it { expect(results).to have_key(:public_id) }
+        it { expect(results).to have_key(:role) }
+        it('returns no error messages') { expect(error_messages).to be_empty }
+      end
     end
-  end
 
-  describe '#update' do
-    let(:results) { update[0] }
-    let(:error_messages) { update[1] }
+    describe '#update' do
+      let(:results) { update[0] }
+      let(:error_messages) { update[1] }
 
-    context 'when missing id' do
-      let(:update) { subject.update(nil, params: 'params') }
+      context 'when missing id' do
+        let(:update) { subject.update(nil, params: 'params') }
 
-      it do
-        expect { update }.to raise_error(FinAppsCore::MissingArgumentsError)
+        it do
+          expect { update }.to raise_error(FinAppsCore::MissingArgumentsError)
+        end
       end
-    end
 
-    context 'when missing params' do
-      let(:update) { subject.update(:valid_id, nil) }
+      context 'when missing params' do
+        let(:update) { subject.update(:valid_id, nil) }
 
-      it do
-        expect { update }.to raise_error(FinAppsCore::MissingArgumentsError)
+        it do
+          expect { update }.to raise_error(FinAppsCore::MissingArgumentsError)
+        end
       end
-    end
 
-    context 'with invalid params' do
-      let(:update) { subject.update(:invalid_id, params: 'params') }
+      context 'with invalid params' do
+        let(:update) { subject.update(:invalid_id, params: 'params') }
 
-      it { expect { update }.not_to raise_error }
-      it('results is nil') { expect(results).to be_nil }
+        it { expect { update }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
 
-      it('error messages array is populated') do
-        expect(error_messages.first.downcase).to eq('resource not found')
+        it('error messages array is populated') do
+          expect(error_messages.first.downcase).to eq('resource not found')
+        end
       end
-    end
 
-    context 'with valid params' do
-      let(:update) { subject.update(:valid_id, params: 'valid params') }
+      context 'with valid params' do
+        let(:update) { subject.update(:valid_id, params: 'valid params') }
 
-      it { expect { update }.not_to raise_error }
-      it('returns an array') { expect(update).to be_a(Array) }
-
-      it('performs a put and returns the response') do
-        expect(results).to have_key(:email)
-        expect(results).to have_key(:role)
+        it { expect { update }.not_to raise_error }
+        it('returns an array') { expect(update).to be_a(Array) }
+        it { expect(results).to have_key(:email) }
+        it { expect(results).to have_key(:role) }
+        it('returns no error messages') { expect(error_messages).to be_empty }
       end
-
-      it('returns no error messages') { expect(error_messages).to be_empty }
     end
-  end
 
-  describe '#update_password' do
-    let(:results) { update_password[0] }
-    let(:error_messages) { update_password[1] }
+    describe '#update_password' do
+      let(:results) { update_password[0] }
+      let(:error_messages) { update_password[1] }
 
-    context 'when missing params' do
-      let(:update_password) { subject.update_password(nil) }
+      context 'when missing params' do
+        let(:update_password) { subject.update_password(nil) }
 
-      it do
-        expect { update_password }.to raise_error(
-          FinAppsCore::MissingArgumentsError
-        )
+        it do
+          expect { update_password }.to raise_error(
+            FinAppsCore::MissingArgumentsError
+          )
+        end
       end
-    end
 
-    context 'with invalid params' do
-      let(:update_password) { subject.update_password(password: 'invalid') }
+      context 'with invalid params' do
+        let(:update_password) { subject.update_password(password: 'invalid') }
 
-      it do
-        expect { update_password }.to raise_error(
-          FinAppsCore::InvalidArgumentsError
-        )
+        it do
+          expect { update_password }.to raise_error(
+            FinAppsCore::InvalidArgumentsError
+          )
+        end
       end
-    end
-
-    context 'with valid params' do
-      let(:valid_params) do
-        {password: 'valid password', password_confirm: 'valid_password'}
-      end
-      let(:update_password) { subject.update_password(valid_params) }
 
-      it { expect { update_password }.not_to raise_error }
-      it('returns an array') { expect(update_password).to be_a(Array) }
+      context 'with valid params' do
+        let(:valid_params) do
+          {password: 'valid password', password_confirm: 'valid_password'}
+        end
+        let(:update_password) { subject.update_password(valid_params) }
 
-      it('performs a post and returns the response') do
-        expect(results).to have_key(:public_id)
-        expect(results).to have_key(:role)
+        it { expect { update_password }.not_to raise_error }
+        it('returns an array') { expect(update_password).to be_a(Array) }
+        it { expect(results).to have_key(:public_id) }
+        it { expect(results).to have_key(:role) }
+        it('returns no error messages') { expect(error_messages).to be_empty }
       end
-
-      it('returns no error messages') { expect(error_messages).to be_empty }
     end
-  end
 
-  describe '#destroy' do
-    let(:results) { destroy[0] }
-    let(:error_messages) { destroy[1] }
+    describe '#destroy' do
+      let(:results) { destroy[0] }
+      let(:error_messages) { destroy[1] }
 
-    context 'when missing id' do
-      let(:destroy) { subject.destroy(nil) }
+      context 'when missing id' do
+        let(:destroy) { subject.destroy(nil) }
 
-      it do
-        expect { destroy }.to raise_error(FinAppsCore::MissingArgumentsError)
+        it do
+          expect { destroy }.to raise_error(FinAppsCore::MissingArgumentsError)
+        end
       end
-    end
 
-    context 'for invalid id' do
-      let(:destroy) { subject.destroy(:invalid_id) }
+      context 'with invalid id' do
+        let(:destroy) { subject.destroy(:invalid_id) }
 
-      it { expect { destroy }.not_to raise_error }
-      it('results is nil') { expect(results).to be_nil }
+        it { expect { destroy }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
 
-      it('error messages array is populated') do
-        expect(error_messages.first.downcase).to eq('resource not found')
+        it('error messages array is populated') do
+          expect(error_messages.first.downcase).to eq('resource not found')
+        end
       end
-    end
 
-    context 'for valid id' do
-      let(:destroy) { subject.destroy(:valid_id) }
+      context 'with valid id' do
+        let(:destroy) { subject.destroy(:valid_id) }
 
-      it { expect { destroy }.not_to raise_error }
-      it('results is nil') { expect(results).to be_nil }
-      it('error_messages array is empty') { expect(error_messages).to eq([]) }
+        it { expect { destroy }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
+        it('error_messages array is empty') { expect(error_messages).to eq([]) }
+      end
     end
   end
 end