finapps 6.4.0 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8428ee4965080f78c083fc2e3d0de2fc66b59596bf5ea81bbbc17e2c11ad2b39
-  data.tar.gz: 0656c926f0b3c70929fb6fbe1b69282d766c56c777aa32ed377218ceac9a6824
+  metadata.gz: 5e80a928ff71e2322588992ecaaccb749ef54da3885b691b7397fc0e78be6061
+  data.tar.gz: c37736f652f09f2c7066e9a45df9c4718b9c933d914716251d5e3105d9bb465f
 SHA512:
-  metadata.gz: 4163eda4a00e4df6c1a34cd76733d11c53fc4774899aabea933bbfe304e5acbd92ea714ccbbd974f8bd496278e501d7fd0d8591ad503480356e9ca75f98198ee
-  data.tar.gz: 756edbc47cdb115e15efe6dc53be0aeea1610feb93470fed421105ce2a7a6b8fa59c04fc84c99c9c5d75a8914b21de5e68d69c29ff584ab810506f948daed233
+  metadata.gz: f7a0e0ca416920b490133e964d36b4a6a86a0c5c759cbf01a30e1b3158ef66abe1c67ecf3fe2d90fb20355824a69839585090bb16fe21448468c28704bab32aa
+  data.tar.gz: 33788efee5a351ff06001daa933578a54965de86e9b949cc8b1631e93a3c890f888d890a5e5e9af8939679d0bf2ba83702034621ae10503d27885aced872e8a3

data/.github/release-drafter.yml

@@ -39,7 +39,7 @@ exclude-labels:
   - invalid
   
 template: |
-  ## [$RESOLVED_VERSION](https://github.com/finapps/ruby-client/compare/$PREVIOUS_TAG...$RESOLVED_VERSION)
+  ## [$RESOLVED_VERSION](https://github.com/finapps/ruby-client/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION)
   $CHANGES
 
 replacers:

data/lib/finapps/rest/operators.rb

@@ -57,22 +57,33 @@ module FinApps
       end
 
       def build_filter(params)
-        filter = {}
-        filter.merge!(search_query(params[:searchTerm])) if params[:searchTerm]
-        filter.merge!(role_query(params[:role])) if params[:role]
-        filter
+        term_filter(params[:searchTerm]).merge(role_filter(params[:role]))
       end
 
-      def search_query(term)
-        {last_name: term}
+      def term_filter(term)
+        return {} unless term
+
+        {'$or': term_array(term)}
+      end
+
+      def term_array(term)
+        [
+          {email: term},
+          {last_name: term}
+        ]
+      end
+
+      def role_filter(role)
+        return {} unless role
+
+        roles = to_integers_array(role)
+        return {} if roles.empty?
+
+        {role: {'$in': roles}}
       end
 
-      def role_query(role)
-        if role.is_a?(Array)
-          {role: {'$in': role.map(&:to_i)}}
-        else
-          {role: role.to_i}
-        end
+      def to_integers_array(role)
+        (role.respond_to?(:map) ? role : [role]).map {|i| Integer(i) }.compact
       end
     end
   end

data/lib/finapps/rest/screenings.rb

@@ -98,24 +98,19 @@ module FinApps
       def from_filter(from_date)
         return {} unless from_date
 
-        {'$gte': to_rfc_date(from_date.to_s)}
+        {'$gte': from_date}
       end
 
       def to_filter(to_date)
         return {} unless to_date
 
-        {'$lt': to_rfc_date(to_date.to_s)}
-      end
-
-      def to_rfc_date(str)
-        date = DateTime.parse(str)
-        date.rfc3339
+        {'$lt': to_date}
       end
 
       def progress_filter(progress)
         return {} unless progress
 
-        {progress: progress}
+        {progress: Integer(progress)}
       end
 
       def space?(string)

data/lib/finapps/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinApps
-  VERSION = '6.4.0'
+  VERSION = '6.5.0'
 end

data/spec/rest/documents_orders_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::DocumentsOrders do
   include SpecHelpers::Client
@@ -215,7 +215,7 @@ RSpec.describe FinApps::REST::DocumentsOrders do
       end
     end
 
-    context 'with missing  params' do
+    context 'with missing params' do
       let(:params) { nil }
 
       it_behaves_like 'a request that raises an error'

data/spec/rest/documents_upload_types_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::DocumentsUploadTypes do
   include SpecHelpers::Client

data/spec/rest/documents_uploads_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::DocumentsUploads do
   include SpecHelpers::Client

data/spec/rest/esign_templates_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::EsignTemplates do
   include SpecHelpers::Client

data/spec/rest/operators_spec.rb

@@ -1,251 +1,245 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::Operators do
-  context 'when initialized with valid FinApps::Client object' do
-    include SpecHelpers::Client
-    subject(:operators) { described_class.new(client) }
+  include SpecHelpers::Client
 
-    describe '#list' do
-      let(:list) { subject.list(params) }
-      let(:results) { list[0] }
-      let(:error_messages) { list[1] }
+  let(:results) { subject[RESULTS] }
+  let(:error_messages) { subject[ERROR_MESSAGES] }
 
-      context 'when missing params' do
-        let(:params) { nil }
-
-        it { expect { list }.not_to raise_error }
+  describe '#list' do
+    subject(:list) { described_class.new(client).list(params) }
 
-        it('performs a get and returns the response') do
-          expect(results).to have_key(:records)
+    context 'with valid params' do
+      RSpec.shared_examples 'a filtereable GET index request' do |filter|
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it_behaves_like 'a GET index request'
+        it 'builds query and sends proper request' do
+          query_string = ("?filter=#{ERB::Util.url_encode filter.to_json}" if filter)
+          url = "#{versioned_api_path}/operators#{query_string}"
+          list
+          expect(WebMock).to have_requested(:get, url)
         end
+      end
 
-        it('returns an array of records') do
-          expect(results[:records]).to be_a(Array)
-        end
+      context 'with searchTerm' do
+        let(:params) { {searchTerm: 'le term'} }
+
+        it_behaves_like 'a filtereable GET index request', {
+          '$or': [
+            {email: 'le term'},
+            {last_name: 'le term'}
+          ]
+        }
+      end
 
-        it('returns no error messages') { expect(error_messages).to be_empty }
+      context 'with valid role' do
+        let(:params) { {role: 1} }
+
+        it_behaves_like 'a filtereable GET index request', {role: {'$in': [1]}}
       end
 
-      context 'when invalid params are provided' do
-        let(:params) { ['invalid array'] }
+      context 'with empty params' do
+        let(:params) { nil }
 
-        it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
+        it_behaves_like 'a filtereable GET index request', nil
       end
 
-      context 'when including valid params' do
+      context 'with searchTerm, page, sort, requested and role' do
         let(:params) do
           {
+            searchTerm: 't',
             page: 2,
             sort: 'date_created',
             requested: 25,
-            searchTerm: 'term',
             role: 2
           }
         end
 
-        it { expect { list }.not_to raise_error }
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it_behaves_like 'a GET index request'
+        it 'builds a full filter and query and sends the request' do
+          list
 
-        it('performs a get and returns the response') do
-          expect(results).to have_key(:records)
+          filter = {'$or': [{email: 't'}, {last_name: 't'}], role: {'$in': [2]}}
+          expect(WebMock).to have_requested(:get, "#{versioned_api_path}/operators"\
+                                                  "?filter=#{ERB::Util.url_encode filter.to_json}"\
+                                                  '&page=2&requested=25&sort=date_created')
         end
+      end
+    end
 
-        it('returns an array of records') do
-          expect(results[:records]).to be_a(Array)
-        end
+    context 'with invalid role' do
+      let(:params) { {role: 'ADMIN'} }
 
-        it('returns no error messages') { expect(error_messages).to be_empty }
+      it { expect { list }.to raise_error(ArgumentError) }
+    end
 
-        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
+    context 'with invalid params' do
+      let(:params) { :anything_but_a_hash }
+
+      it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
     end
+  end
 
-    describe '#show' do
-      let(:results) { show[0] }
-      let(:error_messages) { show[1] }
+  RSpec.shared_examples 'a missing id' do
+    it { expect { subject }.to raise_error(FinAppsCore::MissingArgumentsError) }
+  end
 
-      context 'when missing id' do
-        let(:show) { subject.show(nil) }
+  RSpec.shared_examples 'an invalid id' do
+    it { expect { subject }.not_to raise_error }
+    it('results is nil') { expect(results).to be_nil }
 
-        it { expect { show }.to raise_error(FinAppsCore::MissingArgumentsError) }
-      end
+    it('error messages array is populated') do
+      expect(error_messages.first.downcase).to eq('resource not found')
+    end
+  end
 
-      context 'with invalid id' do
-        let(:show) { subject.show(:invalid_id) }
+  RSpec.shared_examples 'a missing params' do
+    it { expect { subject }.to raise_error(FinAppsCore::MissingArgumentsError) }
+  end
 
-        it { expect { show }.not_to raise_error }
-        it('results is nil') { expect(results).to be_nil }
+  describe '#show' do
+    subject(:show) { described_class.new(client).show(id) }
 
-        it('error messages array is populated') do
-          expect(error_messages.first.downcase).to eq('resource not found')
-        end
-      end
+    context 'when missing id' do
+      let(:id) { nil }
 
-      context 'with valid id' do
-        let(:show) { subject.show(:valid_id) }
+      it_behaves_like 'a missing id'
+    end
 
-        it { expect { show }.not_to raise_error }
-        it('returns an array') { expect(show).to be_a(Array) }
+    context 'with invalid id' do
+      let(:id) { :invalid_id }
 
-        it('performs a get and returns the response') do
-          expect(results).to have_key(:public_id)
-        end
+      it_behaves_like 'an invalid id'
+    end
+
+    context 'with valid id' do
+      let(:id) { :valid_id }
 
-        it('returns no error messages') { expect(error_messages).to be_empty }
+      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(:public_id)
       end
     end
+  end
 
-    describe '#create' do
-      let(:results) { create[0] }
-      let(:error_messages) { create[1] }
+  describe '#create' do
+    subject(:create) { described_class.new(client).create(params) }
 
-      context 'when missing params' do
-        let(:create) { subject.create(nil) }
+    context 'when missing params' do
+      let(:params) { nil }
 
-        it do
-          expect { create }.to raise_error(FinAppsCore::MissingArgumentsError)
-        end
-      end
+      it_behaves_like 'a missing params'
+    end
 
-      context 'when invalid params are provided' do
-        let(:create) { subject.create(params: 'invalid') }
+    context 'when invalid params are provided' do
+      let(:params) { :invalid }
 
-        it { expect { create }.not_to raise_error }
-        it('results is nil') { expect(results).to be_nil }
+      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
+      it('error messages array is populated') do
+        expect(error_messages.first.downcase).to eq('invalid request body')
       end
+    end
 
-      context 'when valid params are provided' do
-        let(:create) { subject.create(params: 'valid') }
+    context 'when valid params are provided' do
+      let(:params) { {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
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it { expect(results).to have_key(:public_id) }
+      it { expect(results).to have_key(:role) }
     end
+  end
 
-    describe '#update' do
-      let(:results) { update[0] }
-      let(:error_messages) { update[1] }
-
-      context 'when missing id' do
-        let(:update) { subject.update(nil, params: 'params') }
+  describe '#update' do
+    subject(:update) { described_class.new(client).update(id, params) }
 
-        it do
-          expect { update }.to raise_error(FinAppsCore::MissingArgumentsError)
-        end
-      end
+    context 'when missing id' do
+      let(:id) { nil }
+      let(:params) { {params: :valid} }
 
-      context 'when missing params' do
-        let(:update) { subject.update(:valid_id, nil) }
+      it_behaves_like 'a missing id'
+    end
 
-        it do
-          expect { update }.to raise_error(FinAppsCore::MissingArgumentsError)
-        end
-      end
+    context 'when missing params' do
+      let(:id) { :id }
+      let(:params) { nil }
 
-      context 'with invalid params' do
-        let(:update) { subject.update(:invalid_id, params: 'params') }
+      it_behaves_like 'a missing params'
+    end
 
-        it { expect { update }.not_to raise_error }
-        it('results is nil') { expect(results).to be_nil }
+    context 'with invalid id' do
+      let(:id) { :invalid_id }
+      let(:params) { {params: :valid} }
 
-        it('error messages array is populated') do
-          expect(error_messages.first.downcase).to eq('resource not found')
-        end
-      end
+      it_behaves_like 'an invalid id'
+    end
 
-      context 'with valid params' do
-        let(:update) { subject.update(:valid_id, params: 'valid params') }
+    context 'with valid params' do
+      let(:id) { :valid_id }
+      let(:params) { {params: :valid} }
 
-        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_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it { expect(results).to have_key(:email) }
+      it { expect(results).to have_key(:role) }
     end
+  end
 
-    describe '#update_password' do
-      let(:results) { update_password[0] }
-      let(:error_messages) { update_password[1] }
+  describe '#update_password' do
+    subject(:update_password) { described_class.new(client).update_password(params) }
 
-      context 'when missing params' do
-        let(:update_password) { subject.update_password(nil) }
+    context 'when missing params' do
+      let(:params) { nil }
 
-        it do
-          expect { update_password }.to raise_error(
-            FinAppsCore::MissingArgumentsError
-          )
-        end
-      end
+      it_behaves_like 'a missing params'
+    end
 
-      context 'with invalid params' do
-        let(:update_password) { subject.update_password(password: 'invalid') }
+    context 'with invalid params' do
+      let(:params) { {foo: :bar} }
 
-        it do
-          expect { update_password }.to raise_error(
-            FinAppsCore::InvalidArgumentsError
-          )
-        end
-      end
+      it { expect { update_password }.to raise_error(FinAppsCore::InvalidArgumentsError) }
+    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) }
+    context 'with valid params' do
+      let(:params) { {password: 'valid', password_confirm: 'valid'} }
 
-        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_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it { expect(results).to have_key(:email) }
+      it { expect(results).to have_key(:role) }
     end
+  end
 
-    describe '#destroy' do
-      let(:results) { destroy[0] }
-      let(:error_messages) { destroy[1] }
-
-      context 'when missing id' do
-        let(:destroy) { subject.destroy(nil) }
+  describe '#destroy' do
+    subject(:destroy) { described_class.new(client).destroy(id) }
 
-        it do
-          expect { destroy }.to raise_error(FinAppsCore::MissingArgumentsError)
-        end
-      end
+    context 'when missing id' do
+      let(:id) { nil }
 
-      context 'with invalid id' do
-        let(:destroy) { subject.destroy(:invalid_id) }
+      it_behaves_like 'a missing id'
+    end
 
-        it { expect { destroy }.not_to raise_error }
-        it('results is nil') { expect(results).to be_nil }
+    context 'with invalid id' do
+      let(:id) { :invalid_id }
 
-        it('error messages array is populated') do
-          expect(error_messages.first.downcase).to eq('resource not found')
-        end
-      end
+      it_behaves_like 'an invalid id'
+    end
 
-      context 'with valid id' do
-        let(:destroy) { subject.destroy(:valid_id) }
+    context 'with valid id' do
+      let(:id) { :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([]) }
-      end
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('results is nil') { expect(results).to be_nil }
     end
   end
 end

data/spec/rest/plaid/plaid_account_permissions_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::PlaidAccountPermissions do
   include SpecHelpers::Client

data/spec/rest/plaid/plaid_accounts_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::PlaidAccounts do
   include SpecHelpers::Client

data/spec/rest/plaid/plaid_consumer_institutions_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::PlaidConsumerInstitutions do
   include SpecHelpers::Client

data/spec/rest/plaid/plaid_institution_logos_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::PlaidInstitutionLogos do
   include SpecHelpers::Client

data/spec/rest/plaid/plaid_webhooks_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::PlaidWebhooks do
   include SpecHelpers::Client

data/spec/rest/screenings_spec.rb

@@ -1,86 +1,95 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::Screenings do
   include SpecHelpers::Client
 
-  let(:results) { subject[0] }
-  let(:error_messages) { subject[1] }
+  let(:results) { subject[RESULTS] }
+  let(:error_messages) { subject[ERROR_MESSAGES] }
 
   describe '#list' do
     subject(:list) { described_class.new(client).list(params) }
 
     context 'with valid params' do
-      context 'without searchTerm' do
-        let(:params) { {searchTerm: nil, page: 2} }
+      let(:params) { {} }
 
+      RSpec.shared_examples 'a correct query builder' do |filter|
         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)
+        it_behaves_like 'a GET index request'
+        it 'builds query and sends proper request' do
+          list
+          encoded_filter = ERB::Util.url_encode filter.to_json
+          url = "#{versioned_api_path}/screenings?filter=#{encoded_filter}"
+
+          expect(WebMock).to have_requested(:get, url)
         end
+      end
+
+      context 'without searchTerm' do
+        let(:params) { {searchTerm: nil, page: 2} }
 
         it 'builds query and sends proper request' do
           list
           url = "#{versioned_api_path}/screenings?page=2"
+
           expect(WebMock).to have_requested(:get, url)
         end
       end
 
-      # rubocop:disable RSpec/ExampleLength
+      context 'with from date' do
+        let(:params) { {fromDate: 'from'} }
+
+        it_behaves_like 'a correct query builder', {
+          '*date_created': {'$gte': 'from'}
+        }
+      end
+
+      context 'with to date' do
+        let(:params) { {toDate: 'to'} }
+
+        it_behaves_like 'a correct query builder', {
+          '*date_created': {'$lt': 'to'}
+        }
+      end
+
       context 'with date range' do
-        let(:params) { {fromDate: '08/01/2021', toDate: '09/01/2021'} }
+        let(:params) { {fromDate: 'from', toDate: 'to'} }
 
-        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_behaves_like 'a correct query builder', {
+          '*date_created': {'$gte': 'from', '$lt': 'to'}
+        }
+      end
 
-        it 'builds query and sends proper request' do
-          list
-          json_filter = {
-            '*date_created': {'$gte': '2021-01-08T00:00:00%2B00:00',
-                              '$lt': '2021-01-09T00:00:00%2B00:00'}
-          }.to_json
-          encoded_filter = ERB::Util.url_encode json_filter
-          url = "#{versioned_api_path}/screenings?filter=#{encoded_filter}"
+      context 'with invalid progress' do
+        let(:params) { {progress: 'not-an-integer'} }
 
-          expect(WebMock).to have_requested(:get, url)
-        end
+        it { expect { list }.to raise_error(ArgumentError) }
       end
-      # rubocop:enable RSpec/ExampleLength
 
-      # rubocop:disable RSpec/ExampleLength
-      context 'with searchTerm' do
-        let(:params) { {searchTerm: 'le term'} }
+      context 'with valid progress' do
+        let(:params) { {progress: '10'} }
 
-        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_behaves_like 'a correct query builder', {progress: 10}
+      end
 
-        it 'builds query and sends proper request' do
-          list
-          json_filter = {'$or': [{'consumer.public_id': 'le term'},
-                                 {'consumer.email': 'le term'},
-                                 {'consumer.first_name': 'le term'},
-                                 {'consumer.last_name': 'le term'},
-                                 {'consumer.external_id': 'le term'},
-                                 {'consumer.first_name': 'le'},
-                                 {'consumer.last_name': 'le'},
-                                 {'consumer.first_name': 'term'},
-                                 {'consumer.last_name': 'term'}]}.to_json
-          encoded_filter = ERB::Util.url_encode json_filter
-          url = "#{versioned_api_path}/screenings?filter=#{encoded_filter}"
+      context 'with searchTerm' do
+        let(:params) { {searchTerm: 'le term'} }
 
-          expect(WebMock).to have_requested(:get, url)
-        end
+        it_behaves_like 'a correct query builder', {
+          '$or': [{'consumer.public_id': 'le term'},
+                  {'consumer.email': 'le term'},
+                  {'consumer.first_name': 'le term'},
+                  {'consumer.last_name': 'le term'},
+                  {'consumer.external_id': 'le term'},
+                  {'consumer.first_name': 'le'},
+                  {'consumer.last_name': 'le'},
+                  {'consumer.first_name': 'term'},
+                  {'consumer.last_name': 'term'}]
+        }
       end
-      # rubocop:enable RSpec/ExampleLength
     end
 
     context 'with invalid params' do
@@ -94,9 +103,7 @@ RSpec.describe FinApps::REST::Screenings do
 
       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_behaves_like 'a GET index request'
     end
   end
 

data/spec/rest/signed_documents_downloads_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::SignedDocumentsDownloads do
   include SpecHelpers::Client

data/spec/rest/verix/verix_documents_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::VerixDocuments do
   include SpecHelpers::Client

data/spec/rest/verix/verix_metadata_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::VerixMetadata do
   include SpecHelpers::Client

data/spec/rest/verix/verix_pdf_documents_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::VerixPdfDocuments do
   include SpecHelpers::Client

data/spec/rest/verix/verix_records_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helpers/client'
-require 'rest/api_request'
+require 'spec_helpers/api_request'
 
 RSpec.describe FinApps::REST::VerixRecords do
   include SpecHelpers::Client

data/spec/{rest → spec_helpers}/api_request.rb

@@ -1,12 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.shared_examples 'an API request' do |_parameter|
-  it do
-    expect do
-      # noinspection RubyBlockToMethodReference
-      subject
-    end.not_to raise_error
-  end
+  it { expect { subject }.not_to raise_error }
 
   it('returns an array') { expect(subject).to be_a(Array) }
 end
@@ -17,10 +12,18 @@ RSpec.shared_examples 'a successful request' do |_parameter|
   end
 end
 
-RSpec.shared_examples 'a request that raises an error' do |_parameter|
+RSpec.shared_examples 'a request that raises an error' do |parameter|
   it do
     expect { subject }.to raise_error(
-      FinAppsCore::MissingArgumentsError
+      parameter || FinAppsCore::MissingArgumentsError
     )
   end
 end
+
+RSpec.shared_examples 'a GET index request' do
+  it { expect(results).to have_key(:records) }
+
+  it('returns an array of records') do
+    expect(results[:records]).to be_a(Array)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.5.0
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -307,7 +307,6 @@ files:
 - lib/finapps/version.rb
 - spec/rest/alert_definitions_spec.rb
 - spec/rest/alert_occurrences_spec.rb
-- spec/rest/api_request.rb
 - spec/rest/client_spec.rb
 - spec/rest/consumer_login_tokens_spec.rb
 - spec/rest/consumers_portfolios_spec.rb
@@ -351,6 +350,7 @@ files:
 - spec/rest/verix/verix_records_spec.rb
 - spec/rest/version_spec.rb
 - spec/spec_helper.rb
+- spec/spec_helpers/api_request.rb
 - spec/spec_helpers/client.rb
 - spec/support/documents_uploads_routes.rb
 - spec/support/fake_api.rb
@@ -463,6 +463,7 @@ test_files:
 - spec/support/fake_api.rb
 - spec/support/documents_uploads_routes.rb
 - spec/spec_helper.rb
+- spec/spec_helpers/api_request.rb
 - spec/spec_helpers/client.rb
 - spec/rest/portfolios_alerts_spec.rb
 - spec/rest/products_spec.rb
@@ -481,7 +482,6 @@ test_files:
 - spec/rest/verix/verix_documents_spec.rb
 - spec/rest/verix/verix_records_spec.rb
 - spec/rest/verix/verix_pdf_documents_spec.rb
-- spec/rest/api_request.rb
 - spec/rest/tenant_settings_spec.rb
 - spec/rest/consumers_spec.rb
 - spec/rest/client_spec.rb