finapps 5.0.45 → 5.2.1

data/lib/finapps/version.rb

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

data/spec/rest/api_request.rb

@@ -16,3 +16,11 @@ RSpec.shared_examples 'a successful request' do |_parameter|
     expect(subject[ERROR_MESSAGES]).to be_empty
   end
 end
+
+RSpec.shared_examples 'a request that raises an error' do |_parameter|
+  it do
+    expect { subject }.to raise_error(
+      FinAppsCore::MissingArgumentsError
+    )
+  end
+end

data/spec/rest/documents_orders_spec.rb

@@ -6,14 +6,6 @@ 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) }
 
@@ -60,33 +52,30 @@ RSpec.describe FinApps::REST::DocumentsOrders do
             "#{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 '
+            '%7B%22applicant.last_name%22:%22term%22%7D,'\
+            '%7B%22applicant.external_id%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'
+              '%22Blue%20Jay%22%7D,%7B%22applicant.first_name%22:'\
+              '%22Blue%20Jay%22%7D,%7B%22applicant.last_name%22:'\
+              '%22Blue%20Jay%22%7D,%7B%22applicant.external_id%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%22'\
+              'applicant.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
@@ -134,14 +123,28 @@ RSpec.describe FinApps::REST::DocumentsOrders do
     let(:error_messages) { show[1] }
 
     context 'with valid id' do
-      let(:id) { :valid_order_id }
+      context 'when id is an identifier' 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_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it('has an order_id node in the response') do
+          expect(results).to have_key(:order_id)
+        end
+      end
 
-      it('performs a get and returns the response') do
-        expect(results).to have_key(:order_id)
+      context 'when id is a token' do
+        let(:id) { '0123456abc.0123456abc.0123456abc' }
+
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it('has an order node in the response') do
+          expect(results).to have_key(:order)
+        end
+
+        it('has a consumer node in the response') do
+          expect(results).to have_key(:consumer)
+        end
       end
     end
 
@@ -168,17 +171,17 @@ RSpec.describe FinApps::REST::DocumentsOrders do
     context 'with valid params' do
       let(:params) do
         {
-          "applicant": {
-            "email": 'validemail@financialapps.com',
-            "first_name": 'Emily',
-            "last_name": 'Macs',
-            "role": 'patient'
+          applicant: {
+            email: 'validemail@financialapps.com',
+            first_name: 'Emily',
+            last_name: 'Macs',
+            role: 'patient'
           },
-          "esign_documents": [
+          esign_documents: [
             'temp-id'
           ],
-          "reference_no": 'REFNO',
-          "tag": 'new'
+          reference_no: 'REFNO',
+          tag: 'new'
         }
       end
 
@@ -194,13 +197,13 @@ RSpec.describe FinApps::REST::DocumentsOrders do
     context 'with invalid params' do
       let(:params) do
         {
-          "applicant": {
-            "email": 'validemail@financialapps.com',
-            "first_name": 'Emily',
-            "last_name": 'Macs',
-            "role": 'patient'
+          applicant: {
+            email: 'validemail@financialapps.com',
+            first_name: 'Emily',
+            last_name: 'Macs',
+            role: 'patient'
           },
-          "reference_no": 'REFNO'
+          reference_no: 'REFNO'
         }
       end
 
@@ -230,7 +233,7 @@ 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'
@@ -238,7 +241,7 @@ RSpec.describe FinApps::REST::DocumentsOrders do
       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 }

data/spec/rest/screenings_spec.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::Screenings do
+  include SpecHelpers::Client
+
+  let(:results) { subject[0] }
+  let(:error_messages) { subject[1] }
+
+  describe '#list' do
+    subject(:list) { described_class.new(client).list(params) }
+
+    context 'with valid params' do
+      let(:params) do
+        {
+          page: 2,
+          sort: 'date_created',
+          requested: 25,
+          searchTerm: 'term'
+        }
+      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}/screenings?page=2"
+          expect(WebMock).to have_requested(:get, url)
+        end
+      end
+
+      # rubocop:disable RSpec/ExampleLength
+      context 'with searchTerm' 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}/screenings?filter=%7B%22$or%22:%5B%7B%22" \
+            'consumer.public_id%22:%22term%22%7D,%7B%22consumer.email%22:%22' \
+            'term%22%7D%5D%7D&page=2&requested=25&sort=date_created'
+
+          expect(WebMock).to have_requested(:get, url)
+        end
+      end
+      # rubocop:enable RSpec/ExampleLength
+    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) }
+
+    context 'with valid id' do
+      let(:id) { :valid_id }
+
+      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(:session)
+      end
+    end
+
+    context 'with invalid id' do
+      let(:id) { :invalid_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 '#last' do
+    subject(:last) { described_class.new(client).last(consumer_id) }
+
+    context 'with valid consumer_id' do
+      let(:consumer_id) { :valid_consumer_id }
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('results have an :s_id node') do
+        expect(results).to have_key(:s_id)
+      end
+    end
+
+    context 'with invalid consumer_id' do
+      let(:consumer_id) { :invalid_consumer_id }
+
+      it { expect(results).to be_nil }
+      it { expect(error_messages).not_to be_empty }
+    end
+
+    context 'when missing consumer_id' do
+      let(:consumer_id) { nil }
+
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+
+  describe '#create' do
+    subject(:create) { described_class.new(client).create(params) }
+
+    context 'with valid params' do
+      let(:params) do
+        {
+          email: 'validemail@financialapps.com',
+          first_name: 'Geo',
+          last_name: 'Metric',
+          public_id: '1234'
+        }
+      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(:question)
+      end
+    end
+
+    context 'with invalid params' do
+      let(:params) { {params: 'invalid'} }
+
+      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) { {} }
+
+    context 'with valid session id' do
+      let(:id) { :valid_id }
+
+      context 'with valid params' do
+        let(:params) { {question_id: '1234'} }
+
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it('returns the next question') do
+          expect(results).to have_key(:question)
+        end
+      end
+
+      context 'with invalid params' do
+        let(:params) { {question_id: '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('question with id (invalid) not found ')
+        end
+      end
+    end
+
+    context 'with invalid session id' do
+      let(:id) { :invalid_id }
+      let(:params) { {question_id: '1234'} }
+
+      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
+  end
+
+  describe '#destroy' do
+    subject(:destroy) { described_class.new(client).destroy(id) }
+
+    context 'with valid session id' do
+      let(:id) { :valid_id }
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('results is nil') { expect(results).to be_nil }
+      it('error_messages is empty') { expect(error_messages).to be_empty }
+    end
+
+    context 'when missing session id' do
+      let(:id) { nil }
+
+      it_behaves_like 'a request that raises an error'
+    end
+
+    context 'with invalid session id' do
+      let(:id) { :invalid_id }
+
+      it_behaves_like 'an API request'
+      it('results is nil') { expect(results).to be_nil }
+
+      it('error_messages is not empty') do
+        expect(error_messages).not_to be_empty
+      end
+
+      it('error messages array is populated') do
+        expect(error_messages.first.downcase).to eq('session not found')
+      end
+    end
+  end
+end

data/spec/support/fake_api.rb

@@ -2,6 +2,8 @@
 
 require 'sinatra/base'
 require_relative 'documents_uploads_routes'
+require_relative 'screenings_routes'
+
 module Fake
   # the FakeApi class is used to mock API requests while testing.
   class FakeApi < Sinatra::Base
@@ -214,6 +216,9 @@ module Fake
     get("/#{version}/documents/orders/valid_order_id") do
       json_response 200, 'documents_order.json'
     end
+    get("/#{version}/documents/retrieve_order") do
+      json_response 200, 'documents/retrieve_order.json'
+    end
     get("/#{version}/documents/orders/invalid_order_id") do
       json_response 404, 'resource_not_found.json'
     end
@@ -272,6 +277,9 @@ module Fake
     # document_upload_types
     get("/#{version}/documents/upload_types") { json_response 200, 'upload_types.json' }
 
+    # screenings
+    include ScreeningsRoutes
+
     # consumers
     get("/#{version}/consumers") do
       json_response 200, 'users.json'
@@ -494,6 +502,10 @@ module Fake
 
     private
 
+    def resource_not_found
+      json_response 404, 'resource_not_found.json'
+    end
+
     def json_response(response_code, file_name)
       http_response :json, response_code, file_name
     end