finapps 5.0.28 → 5.0.33

data/lib/finapps/version.rb

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

data/spec/rest/alert_definitions_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helpers/client'
 
 RSpec.describe FinApps::REST::AlertDefinitions do
   include SpecHelpers::Client
-  subject { FinApps::REST::AlertDefinitions.new(client) }
+  subject { described_class.new(client) }
 
   describe '#list' do
     let(:list) { subject.list(params) }
@@ -16,9 +16,11 @@ RSpec.describe FinApps::REST::AlertDefinitions do
 
       it { expect { list }.not_to raise_error }
       it('returns an array') { expect(list).to be_a(Array) }
+
       it('performs a get and returns the response') do
         expect(results).to have_key(:records)
       end
+
       it('returns no error messages') { expect(errors).to be_empty }
     end
 
@@ -29,14 +31,17 @@ RSpec.describe FinApps::REST::AlertDefinitions do
     end
 
     context 'when including valid params' do
-      let(:params) { { page: 2, sort: '-created_date', requested: 25 } }
+      let(:params) { {page: 2, sort: '-created_date', requested: 25} }
 
       it { expect { list }.not_to raise_error }
       it('returns an array') { expect(list).to be_a(Array) }
+
       it('performs a get and returns the response') do
         expect(results).to have_key(:records)
       end
+
       it('returns no error messages') { expect(errors).to be_empty }
+
       it 'builds query and sends proper request' do
         list
         url =
@@ -63,10 +68,12 @@ RSpec.describe FinApps::REST::AlertDefinitions do
 
       it { expect { show }.not_to raise_error }
       it('returns an array') { expect(show).to be_a(Array) }
+
       it('performs a get and returns the response') do
         expect(results).to have_key(:_id)
         expect(results).to have_key(:rule_name)
       end
+
       it('returns no error messages') { expect(errors).to be_empty }
     end
 
@@ -75,6 +82,7 @@ RSpec.describe FinApps::REST::AlertDefinitions do
 
       it { expect { show }.not_to raise_error }
       it('results is nil') { expect(results).to be_nil }
+
       it('error messages array is populated') do
         expect(errors.first.downcase).to eq('resource not found')
       end

data/spec/rest/alert_occurrences_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helpers/client'
 
 RSpec.describe FinApps::REST::AlertOccurrences do
   include SpecHelpers::Client
-  subject { FinApps::REST::AlertOccurrences.new(client) }
+  subject { described_class.new(client) }
 
   describe '#list' do
     let(:list) { subject.list(params) }
@@ -16,9 +16,11 @@ RSpec.describe FinApps::REST::AlertOccurrences do
 
       it { expect { list }.not_to raise_error }
       it('returns an array') { expect(list).to be_a(Array) }
+
       it('performs a get and returns the response') do
         expect(results).to have_key(:records)
       end
+
       it('returns no error messages') { expect(errors).to be_empty }
     end
 
@@ -40,10 +42,13 @@ RSpec.describe FinApps::REST::AlertOccurrences do
 
       it { expect { list }.not_to raise_error }
       it('returns an array') { expect(list).to be_a(Array) }
+
       it('performs a get and returns the response') do
         expect(results).to have_key(:records)
       end
+
       it('returns no error messages') { expect(errors).to be_empty }
+
       it 'builds query and sends proper request' do
         list
         url =

data/spec/rest/api_request.rb

@@ -7,6 +7,7 @@ RSpec.shared_examples 'an API request' do |_parameter|
       subject
     end.not_to raise_error
   end
+
   it('returns an array') { expect(subject).to be_a(Array) }
 end
 

data/spec/rest/client_spec.rb

@@ -3,14 +3,14 @@
 RSpec.describe FinApps::REST::Client do
   describe '#new' do
     it 'raises for missing company_token' do
-      expect { FinApps::REST::Client.new nil }.to raise_error(
+      expect { described_class.new nil }.to raise_error(
         FinAppsCore::MissingArgumentsError
       )
     end
   end
 
   context 'an instance of Client' do
-    subject { FinApps::REST::Client.new(:company_token) }
+    subject { described_class.new(:company_token) }
 
     FinApps::REST::Client::RESOURCES.each do |method|
       it("responds to #{method}") { expect(subject).to respond_to(method) }

data/spec/rest/consumers_portfolios_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helpers/client'
 
 RSpec.describe FinApps::REST::ConsumersPortfolios do
   include SpecHelpers::Client
-  subject { FinApps::REST::ConsumersPortfolios.new(client) }
+  subject { described_class.new(client) }
 
   describe '#list' do
     let(:list) { subject.list(id, params) }
@@ -24,9 +24,11 @@ RSpec.describe FinApps::REST::ConsumersPortfolios do
 
       it { expect { list }.not_to raise_error }
       it('returns an array') { expect(list).to be_a(Array) }
+
       it('performs a get and returns the response') do
         expect(results).to have_key(:records)
       end
+
       it('returns no error messages') { expect(errors).to be_empty }
     end
 
@@ -39,14 +41,17 @@ RSpec.describe FinApps::REST::ConsumersPortfolios do
 
     context 'when including valid params' do
       let(:id) { 'valid_id' }
-      let(:params) { { page: 2, sort: '-created_date', requested: 25 } }
+      let(:params) { {page: 2, sort: '-created_date', requested: 25} }
 
       it { expect { list }.not_to raise_error }
       it('returns an array') { expect(list).to be_a(Array) }
+
       it('performs a get and returns the response') do
         expect(results).to have_key(:records)
       end
+
       it('returns no error messages') { expect(errors).to be_empty }
+
       it 'builds query and sends proper request' do
         list
         url =

data/spec/rest/consumers_spec.rb

@@ -4,7 +4,8 @@ require 'spec_helpers/client'
 RSpec.describe FinApps::REST::Consumers,
                'initialized with valid FinApps::Client object' do
   include SpecHelpers::Client
-  subject(:users) { FinApps::REST::Consumers.new(client) }
+  subject(:users) { described_class.new(client) }
+
   missing_public_id = ': public_id'
 
   describe '#create' do
@@ -24,9 +25,11 @@ RSpec.describe FinApps::REST::Consumers,
 
       it { expect { create }.not_to raise_error }
       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(:public_id)
       end
+
       it('error_messages array is empty') { expect(error_messages).to eq([]) }
     end
 
@@ -35,6 +38,7 @@ RSpec.describe FinApps::REST::Consumers,
 
       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
@@ -48,10 +52,13 @@ RSpec.describe FinApps::REST::Consumers,
 
     context 'when missing params' do
       let(:params) { nil }
-      it { expect { list }.to_not 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') { expect(results[:records]).to be_a(Array) }
       it('returns no error messages') { expect(error_messages).to be_empty }
     end
@@ -70,14 +77,17 @@ RSpec.describe FinApps::REST::Consumers,
         }
       end
 
-      it { expect { list }.to_not raise_error }
+      it { expect { list }.not_to raise_error }
       it('returns an array') { expect(list).to be_a(Array) }
+
       it('performs a get and returns the response') do
         expect(results).to have_key(:records)
       end
+
       it('returns no error messages') do
         expect(error_messages).to be_empty
       end
+
       it 'builds query and sends proper request' do
         list
         url = "#{versioned_api_path}/consumers?page=3&requested=19"
@@ -95,21 +105,49 @@ RSpec.describe FinApps::REST::Consumers,
         }
       end
 
-      it { expect { list }.to_not raise_error }
+      it { expect { list }.not_to raise_error }
       it('returns an array') { expect(list).to be_a(Array) }
+
       it('performs a get and returns the response') do
         expect(results).to have_key(:records)
       end
+
       it('returns no error messages') do
         expect(error_messages).to be_empty
       end
+
       it 'builds query and sends proper request' do
         list
-        url = "#{versioned_api_path}/consumers?filter=%7B%22$or%22:%5B%7B%22email%22:%22term%22%7D," \
-            '%7B%22first_name%22:%22term%22%7D,%7B%22last_name%22:%22term%22%7D%5D%7D&page=2&requested=25' \
-            '&sort=date_created'
+        url = "#{versioned_api_path}/consumers?"\
+          'filter=%7B%22$or%22:%5B%7B%22email%22:%22term%22%7D,' \
+          '%7B%22first_name%22:%22term%22%7D,'\
+          '%7B%22last_name%22:%22term%22%7D%5D%7D&page=2&requested=25' \
+          '&sort=date_created'
         expect(WebMock).to have_requested(:get, url)
       end
+
+      context 'when search term contains a space' do
+        let(:params) do
+          {
+            page: 2,
+            sort: 'date_created',
+            requested: 25,
+            searchTerm: 'Two terms'
+          }
+        end
+
+        it 'treats space as start of a new query for first and last name' do
+          list
+          url = "#{versioned_api_path}/consumers?"\
+            'filter=%7B%22$or%22:%5B%7B%22email%22:%22Two%20terms%22%7D,'\
+            '%7B%22first_name%22:%22Two%20terms%22%7D,'\
+            '%7B%22last_name%22:%22Two%20terms%22%7D,%7B%22first_name%22:'\
+            '%22Two%22%7D,%7B%22last_name%22:%22Two%22%7D,'\
+            '%7B%22first_name%22:%22terms%22%7D,%7B%22last_name%22:'\
+            '%22terms%22%7D%5D%7D&page=2&requested=25&sort=date_created'
+          expect(WebMock).to have_requested(:get, url)
+        end
+      end
     end
   end
 
@@ -130,9 +168,11 @@ RSpec.describe FinApps::REST::Consumers,
 
       it { expect { show }.not_to raise_error }
       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(:public_id)
       end
+
       it('error_messages array is empty') { expect(error_messages).to eq([]) }
     end
 
@@ -143,6 +183,7 @@ RSpec.describe FinApps::REST::Consumers,
 
       it { expect { show }.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')
       end
@@ -179,6 +220,7 @@ RSpec.describe FinApps::REST::Consumers,
 
         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 user id specified.'
@@ -200,12 +242,15 @@ RSpec.describe FinApps::REST::Consumers,
 
         it { expect { update }.not_to raise_error }
         it('results is a Hash') { expect(results).to be_a(Hash) }
+
         it('the public_id is on the results') do
           expect(results).to have_key(:public_id)
         end
+
         it('the new token is on the results') do
           expect(results).to have_key(:token)
         end
+
         it('error_messages array is empty') { expect(error_messages).to eq([]) }
       end
 
@@ -221,6 +266,7 @@ RSpec.describe FinApps::REST::Consumers,
 
         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')
         end
@@ -254,6 +300,7 @@ RSpec.describe FinApps::REST::Consumers,
 
         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')
         end

data/spec/rest/documents_orders_notifications_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::DocumentsOrdersNotifications do
+  include SpecHelpers::Client
+
+  describe '#create' do
+    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
+    end
+
+    context 'when invalid id is provided' do
+      let(:create) { subject.create(:invalid_id) }
+      let(:results) { create[RESULTS] }
+      let(:error_messages) { create[ERROR_MESSAGES] }
+
+      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
+      let(:create) { subject.create(:valid_id) }
+      let(:results) { create[RESULTS] }
+      let(:error_messages) { create[ERROR_MESSAGES] }
+
+      it { expect { create }.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

data/spec/rest/documents_orders_spec.rb

@@ -0,0 +1,349 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::DocumentsOrders do
+  include SpecHelpers::Client
+
+  RSpec.shared_examples 'a request that raises an error' do |_parameter|
+    it do
+      expect { subject }.to raise_error(
+        FinAppsCore::MissingArgumentsError
+      )
+    end
+  end
+
+  describe '#list' do
+    subject(:list) { described_class.new(client).list(params) }
+
+    let(:results) { list[0] }
+    let(:error_messages) { list[1] }
+
+    context 'with valid params' do
+      let(:params) do
+        {
+          page: 2,
+          sort: 'tag',
+          requested: 25,
+          searchTerm: 'term',
+          consumer: 'valid_consumer_id'
+        }
+      end
+
+      context 'without searchTerm' do
+        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"
+          expect(WebMock).to have_requested(:get, url)
+        end
+      end
+
+      context 'with search term' 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 '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 '
+
+          expect(WebMock).to have_requested(:get, url)
+        end
+
+        context 'with search term containing spaces' do
+          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'
+
+            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(subject.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
+        expect(results).to have_key(:records)
+      end
+    end
+  end
+
+  describe '#show' do
+    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
+    end
+
+    context 'with invalid id' do
+      let(:id) { :invalid_order_id }
+
+      it { expect(results).to be_nil }
+      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) { described_class.new(client).create(params) }
+
+    let(:results) { create[0] }
+    let(:error_messages) { create[1] }
+
+    context 'with valid params' do
+      let(:params) do
+        {
+          "applicant": {
+            "email": 'validemail@financialapps.com',
+            "first_name": 'Emily',
+            "last_name": 'Macs',
+            "role": 'patient'
+          },
+          "esign_documents": [
+            'temp-id'
+          ],
+          "reference_no": 'REFNO',
+          "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
+    end
+
+    context 'with invalid params' do
+      let(:params) do
+        {
+          "applicant": {
+            "email": 'validemail@financialapps.com',
+            "first_name": 'Emily',
+            "last_name": 'Macs',
+            "role": 'patient'
+          },
+          "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
+    end
+
+    context 'with missing  params' do
+      let(:params) { nil }
+
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+
+  describe '#update' do
+    subject(:update) { described_class.new(client).update(id, params) }
+
+    let(:params) { {} }
+    let(:results) { update[0] }
+    let(:error_messages) { update[1] }
+
+    context 'with valid id' do
+      let(:id) { :valid_order_id }
+
+      context 'with valid params' do
+        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'} }
+
+        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
+      end
+    end
+
+    context 'with invalid id' do
+      let(:id) { :invalid_order_id }
+      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'
+        )
+      end
+    end
+
+    context 'with missing id' do
+      let(:id) { nil }
+
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+
+  describe '#destroy' do
+    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 }
+    end
+
+    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
+    end
+
+    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) { 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 }
+    let(:signature_id) { :valid_signature_id }
+
+    context 'with valid order id' do
+      context 'with valid signature id' 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(:sign_url)
+        end
+      end
+
+      context 'with invalid signature id' do
+        let(:signature_id) { :invalid_signature_id }
+
+        it { expect(results).to be_nil }
+        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).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
+end