finapps 5.0.31 → 5.0.36

data/spec/rest/documents_orders_notifications_spec.rb

@@ -6,10 +6,11 @@ RSpec.describe FinApps::REST::DocumentsOrdersNotifications do
   include SpecHelpers::Client
 
   describe '#create' do
-    subject(:notifications) { FinApps::REST::DocumentsOrdersNotifications.new(client) }
+    subject(:notifications) { described_class.new(client) }
 
     context 'when missing id' do
       let(:create) { subject.create(nil) }
+
       it('returns missing argument error') do
         expect { create }.to raise_error(FinAppsCore::MissingArgumentsError)
       end
@@ -22,12 +23,13 @@ RSpec.describe FinApps::REST::DocumentsOrdersNotifications do
 
       it { expect { create }.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('order id is invalid')
       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

@@ -15,7 +15,8 @@ RSpec.describe FinApps::REST::DocumentsOrders do
   end
 
   describe '#list' do
-    subject(:list) { FinApps::REST::DocumentsOrders.new(client).list(params) }
+    subject(:list) { described_class.new(client).list(params) }
+
     let(:results) { list[0] }
     let(:error_messages) { list[1] }
 
@@ -31,12 +32,14 @@ RSpec.describe FinApps::REST::DocumentsOrders do
       end
 
       context 'without searchTerm' do
-        let(:params) { { "searchTerm": nil, "page": 2 } }
+        let(:params) { {searchTerm: nil, page: 2} }
+
         it_behaves_like 'an API request'
         it_behaves_like 'a successful request'
         it 'performs a get and returns the response' do
           expect(results).to have_key(:records)
         end
+
         it 'builds query and sends proper request' do
           list
           url = "#{versioned_api_path}/documents/orders?page=2"
@@ -50,41 +53,72 @@ RSpec.describe FinApps::REST::DocumentsOrders do
         it 'performs a get and returns the response' do
           expect(results).to have_key(:records)
         end
+
         it 'builds query and sends proper request' do
           list
           url =
-            "#{versioned_api_path}/documents/orders?filter=%7B%22$or%22:%5B%7B%22applicant.email%22:"\
-            '%22term%22%7D,%7B%22applicant.first_name%22:%22term%22%7D,%7B%22applicant.last_name%22:'\
-            '%22term%22%7D,%7B%22reference_no%22:%7B%22$regex%22:%22%5Eterm%22,%22$options%22:%22i%22%7D%7D%5D,'\
-            '%22consumer_id%22:%22valid_consumer_id%22%7D&page=2&requested=25&sort=tag '
+            "#{versioned_api_path}/documents/orders?"\
+            'filter=%7B%22$or%22:%5B%7B%22applicant.email%22:'\
+            '%22term%22%7D,%7B%22applicant.first_name%22:%22term%22%7D,'\
+            '%7B%22applicant.last_name%22:'\
+            '%22term%22%7D,%7B%22reference_no%22:%7B%22$regex%22:%22%5Eterm%22,'\
+            '%22$options%22:%22i%22%7D%7D%5D,'\
+            '%22consumer_id%22:%22valid_consumer_id%22%7D&'\
+            'page=2&requested=25&sort=tag '
 
           expect(WebMock).to have_requested(:get, url)
         end
 
         context 'with search term containing spaces' do
-          let(:params) { { "searchTerm": 'Blue Jay', "page": 2 } }
+          let(:params) { {"searchTerm": 'Blue Jay', "page": 2} }
+
           it 'builds query and sends proper request' do
             list
             url =
-              "#{versioned_api_path}/documents/orders?filter=%7B%22$or%22:%5B%7B%22applicant.email%22:"\
-              '%22Blue%20Jay%22%7D,%7B%22applicant.first_name%22:%22Blue%20Jay%22%7D,%7B%22applicant.last_name%22:'\
-              '%22Blue%20Jay%22%7D,%7B%22reference_no%22:%7B%22$regex%22:%22%5EBlue%20Jay%22,%22$options%22:'\
-              '%22i%22%7D%7D,%7B%22applicant.first_name%22:%22Blue%22%7D,%7B%22applicant.last_name%22:%22Blue%22%7D,'\
-              '%7B%22applicant.first_name%22:%22Jay%22%7D,%7B%22applicant.last_name%22:%22Jay%22%7D%5D%7D&page=2'
+              "#{versioned_api_path}/documents/orders?"\
+              'filter=%7B%22$or%22:%5B%7B%22applicant.email%22:'\
+              '%22Blue%20Jay%22%7D,'\
+              '%7B%22applicant.first_name%22:%22Blue%20Jay%22%7D,'\
+              '%7B%22applicant.last_name%22:'\
+              '%22Blue%20Jay%22%7D,'\
+              '%7B%22reference_no%22:%7B%22$regex%22:%22%5EBlue%20Jay%22,'\
+              '%22$options%22:'\
+              '%22i%22%7D%7D,%7B%22applicant.first_name%22:%22Blue%22%7D,'\
+              '%7B%22applicant.last_name%22:%22Blue%22%7D,'\
+              '%7B%22applicant.first_name%22:%22Jay%22%7D,'\
+              '%7B%22applicant.last_name%22:%22Jay%22%7D%5D%7D&page=2'
 
             expect(WebMock).to have_requested(:get, url)
           end
         end
       end
+
+      context 'when filtering by open status ordes' do
+        let(:params) { {status: 1} }
+
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it { expect(list.first[:records]).not_to be_empty }
+      end
+
+      context 'when filtering by closed status ordes' do
+        let(:params) { {status: 2, searchTerm: 'term'} }
+
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it { expect(results[:records]).to be_empty }
+      end
     end
 
     context 'with invalid params' do
       let(:params) { ['invalid array'] }
+
       it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
     end
 
     context 'with missing params' do
       let(:params) { nil }
+
       it_behaves_like 'an API request'
       it_behaves_like 'a successful request'
       it('performs a get and returns the response') do
@@ -94,15 +128,18 @@ RSpec.describe FinApps::REST::DocumentsOrders do
   end
 
   describe '#show' do
-    subject(:show) { FinApps::REST::DocumentsOrders.new(client).show(id) }
+    subject(:show) { described_class.new(client).show(id) }
+
     let(:results) { show[0] }
     let(:error_messages) { show[1] }
 
     context 'with valid id' do
       let(:id) { :valid_order_id }
+
       it_behaves_like 'an API request'
       it_behaves_like 'a successful request'
       it('results is a Hash') { expect(results).to be_a(Hash) }
+
       it('performs a get and returns the response') do
         expect(results).to have_key(:order_id)
       end
@@ -110,18 +147,21 @@ RSpec.describe FinApps::REST::DocumentsOrders do
 
     context 'with invalid id' do
       let(:id) { :invalid_order_id }
+
       it { expect(results).to be_nil }
-      it { expect(error_messages).to_not be_empty }
+      it { expect(error_messages).not_to be_empty }
     end
 
     context 'when missing id' do
       let(:id) { nil }
+
       it_behaves_like 'a request that raises an error'
     end
   end
 
   describe '#create' do
-    subject(:create) { FinApps::REST::DocumentsOrders.new(client).create(params) }
+    subject(:create) { described_class.new(client).create(params) }
+
     let(:results) { create[0] }
     let(:error_messages) { create[1] }
 
@@ -141,9 +181,11 @@ RSpec.describe FinApps::REST::DocumentsOrders do
           "tag": 'new'
         }
       end
+
       it_behaves_like 'an API request'
       it_behaves_like 'a successful request'
       it('results is a Hash') { expect(results).to be_a(Hash) }
+
       it('performs a post and returns the response') do
         expect(results).to have_key(:order_id)
       end
@@ -161,8 +203,10 @@ RSpec.describe FinApps::REST::DocumentsOrders do
           "reference_no": 'REFNO'
         }
       end
+
       it { expect { create }.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')
       end
@@ -170,12 +214,14 @@ RSpec.describe FinApps::REST::DocumentsOrders do
 
     context 'with missing  params' do
       let(:params) { nil }
+
       it_behaves_like 'a request that raises an error'
     end
   end
 
   describe '#update' do
-    subject(:update) { FinApps::REST::DocumentsOrders.new(client).update(id, params) }
+    subject(:update) { described_class.new(client).update(id, params) }
+
     let(:params) { {} }
     let(:results) { update[0] }
     let(:error_messages) { update[1] }
@@ -184,16 +230,19 @@ RSpec.describe FinApps::REST::DocumentsOrders do
       let(:id) { :valid_order_id }
 
       context 'with valid params' do
-        let(:params) { { "tag": 'pending' } }
+        let(:params) { {"tag": 'pending'} }
+
         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 params' do
-        let(:params) { { "tag": 'invalid' } }
+        let(:params) { {"tag": 'invalid'} }
+
         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('invalid request body')
         end
@@ -202,9 +251,11 @@ RSpec.describe FinApps::REST::DocumentsOrders do
 
     context 'with invalid id' do
       let(:id) { :invalid_order_id }
-      let(:params) { { applicant: { first_name: 'Quasar' } } }
+      let(:params) { {applicant: {first_name: 'Quasar'}} }
+
       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(
           'order id is invalid'
@@ -214,17 +265,20 @@ RSpec.describe FinApps::REST::DocumentsOrders do
 
     context 'with missing id' do
       let(:id) { nil }
+
       it_behaves_like 'a request that raises an error'
     end
   end
 
   describe '#destroy' do
-    subject(:destroy) { FinApps::REST::DocumentsOrders.new(client).destroy(id) }
+    subject(:destroy) { described_class.new(client).destroy(id) }
+
     let(:results) { destroy[0] }
     let(:error_messages) { destroy[1] }
 
     context 'with valid id' do
       let(:id) { :valid_order_id }
+
       it_behaves_like 'an API request'
       it_behaves_like 'a successful request'
       it('results is nil') { expect(results).to be_nil }
@@ -232,8 +286,10 @@ RSpec.describe FinApps::REST::DocumentsOrders do
 
     context 'with invalid id' do
       let(:id) { :invalid_order_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
@@ -241,12 +297,14 @@ RSpec.describe FinApps::REST::DocumentsOrders do
 
     context 'with missing id' do
       let(:id) { nil }
+
       it_behaves_like 'a request that raises an error'
     end
   end
 
   describe '#show_signing_url' do
-    subject(:sign_url) { FinApps::REST::DocumentsOrders.new(client).show_signing_url(order_id, signature_id) }
+    subject(:sign_url) { described_class.new(client).show_signing_url(order_id, signature_id) }
+
     let(:results) { sign_url[0] }
     let(:error_messages) { sign_url[1] }
     let(:order_id) { :valid_order_id }
@@ -263,24 +321,28 @@ RSpec.describe FinApps::REST::DocumentsOrders do
 
       context 'with invalid signature id' do
         let(:signature_id) { :invalid_signature_id }
+
         it { expect(results).to be_nil }
-        it { expect(error_messages).to_not be_empty }
+        it { expect(error_messages).not_to be_empty }
       end
     end
 
     context 'with invalid order id' do
       let(:order_id) { :invalid_order_id }
+
       it { expect(results).to be_nil }
-      it { expect(error_messages).to_not be_empty }
+      it { expect(error_messages).not_to be_empty }
     end
 
     context 'with missing order id' do
       let(:order_id) { nil }
+
       it_behaves_like 'a request that raises an error'
     end
 
     context 'with missing signature id' do
       let(:signature_id) { nil }
+
       it_behaves_like 'a request that raises an error'
     end
   end

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