finapps 5.0.41 → 5.0.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b293938018fe5cdcccba1a161ca630d5d1e602a634483c5b1281adf4611c76f
-  data.tar.gz: 2ede0f7dfe44afe57006c8d685f0b550104d3c1395e98d1cf75538f870fbd6bc
+  metadata.gz: 487960017ebcda19c22179e090cb9328708a57dd5e54e0d05cc27e5660251d57
+  data.tar.gz: 95abe37a2a66f36f973eb453d2302df92a9d1208c2ad5f20b4b6caf21737c358
 SHA512:
-  metadata.gz: e14eb4bc25a190d5803163b9cb60c2440be01b1172779c4a16d54f538a76b85e1c4650c7c98776b0185ffa5292e536142a4f899023f5fb6340ba0906f4ca2797
-  data.tar.gz: 0b7fe2a98897d7908657cf9579312449f236ed8611db113b5c88b46a00450ea1ffdfb9d43a2ae155c60197748ffa5a2081702caffc8b4e4a433b25a7d40e9edc
+  metadata.gz: 5df1695cc14dc3a96d47867786a7f564806b5f58d56511c9e08482e3e9ce4767ac03257c055f644b2517d25666a70d0b6312f43fd218607258c642d967061a98
+  data.tar.gz: 9f063fed1bafb02f77ed3b10230c77d757e0ae09c0f7d202f9d78d699dc1d7ba5f0809d59591f608c32aa9c81d86795b932ab5220d0adc13fcea07b2583c4d26

data/.github/workflows/main.yaml

@@ -13,12 +13,10 @@ jobs:
     steps:
       - uses: actions/checkout@v1
 
-      - name: Use Ruby 2.6
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: '2.6'
+      - name: Install required ruby
+        uses: ruby/setup-ruby@v1
 
-      - uses: actions/cache@v1
+      - uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: ${{ runner.os  }}-gems-${{ hashFiles('**/Gemfile.lock')  }}
@@ -27,7 +25,7 @@ jobs:
 
       - name: Install gems
         run: |
-          gem install bundler
+          gem install -N bundler
           bundle config path vendor/bundle
           bundle install --jobs 4 --retry 3
 

data/.github/workflows/release.yml

@@ -12,6 +12,7 @@ jobs:
     steps:
     - uses: actions/checkout@master
       with:
+        persist-credentials: false
         fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
 
     - uses: actions/setup-ruby@v1
@@ -22,13 +23,23 @@ jobs:
       id: get_version
       uses: battila7/get-version-action@v2
 
-    - name: Bump version    
+    - name: Bump version   
       run: |
         gem install -N gem-release
         git config --local user.email "action@github.com"
         git config --local user.name "GitHub Action"
         gem bump --skip-ci --version ${{ steps.get_version.outputs.version-without-v }}
-        git push origin HEAD:master
+        
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        # GitHub Actions token does not support pushing to protected branches.
+        # github_token: ${{ secrets.GITHUB_TOKEN }}
+        #        
+        # A manually populated`PERSONAL_ACCESS_TOKEN` environment variable 
+        # with permissions to push to a protected branch must be used.
+        # not ideal - keep eyes open for a better solution
+        github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
         
     - name: Release gem to rubygems.org    
       run: |

data/README.md

@@ -60,18 +60,20 @@ company_token = 'my-company-token'
 @client = FinApps::REST::Client.new company_identifier, company_token
 ```
 
-## More Information
+### Release
 
-Please check the [FinApps wiki][wiki] for extended documentation.
+For approved Pull Requests against the master branch, an aggregated release draft will be generated. This draft by default bumps the patch number of previous version.
+Please refer to the [Release Drafter] action documentation for information on this process, specifically how to bump the major or minor numbers of the gem version.
 
+As soon as this draft is converted into an actual release, an automated process also running on GitHub actions will be triggered to build the gem and release it to rubygems.org.
 
-[FinancialApps.com][financialapps]
 
+[FinancialApps.com][financialapps]
 
 [bundler]: http://bundler.io
 [financialapps]: https://financialapps.com
-[wiki]: https://github.com/finapps/ruby-client/wiki
 [builder]: http://builder.rubyforge.org/
 [bundler]: http://bundler.io
 [rubygems]: http://rubygems.org
 [build_status]: http://teamciti.powerwallet.com/viewType.html?buildTypeId=FaRuby_BuildMaster&guest=1
+[Release Drafter]: https://github.com/release-drafter/release-drafter

data/finapps.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.test_files = Dir['spec/**/*.rb']
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency     'finapps_core',               '~> 5.0',   '>= 5.0.10'
+  spec.add_runtime_dependency     'finapps_core',               '~> 5.0',   '>= 5.0.13'
 
   spec.add_development_dependency 'bundler',                    '~> 2.0',   '>= 2.0.2'
   spec.add_development_dependency 'codeclimate-test-reporter',  '~> 1.0',   '>= 1.0.9'
@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rspec',                '~> 4.7',   '>= 4.7.3'
   spec.add_development_dependency 'rake',                       '~> 13.0',  '>= 13.0.1'
   spec.add_development_dependency 'rspec',                      '~> 3.9',   '>= 3.9.0'
-  spec.add_development_dependency 'rubocop',                    '~> 0.86',  '>= 0.86.0'
-  spec.add_development_dependency 'rubocop-performance',        '~> 1.6',   '>= 1.6.1'
-  spec.add_development_dependency 'rubocop-rspec',              '~> 1.40',  '>= 1.40.0'
+  spec.add_development_dependency 'rubocop',                    '~> 0.87',  '>= 0.87.0'
+  spec.add_development_dependency 'rubocop-performance',        '~> 1.7',   '>= 1.7.0'
+  spec.add_development_dependency 'rubocop-rspec',              '~> 1.41',  '>= 1.41.0'
   spec.add_development_dependency 'sinatra',                    '~> 2.0',   '>= 2.0.8'
   spec.add_development_dependency 'webmock',                    '~> 3.8',   '>= 3.8.0'
 

data/lib/finapps.rb

@@ -35,6 +35,7 @@ require 'finapps/rest/esign_templates'
 require 'finapps/rest/documents_upload_types'
 require 'finapps/rest/signed_documents_downloads'
 require 'finapps/rest/documents_orders_notifications'
+require 'finapps/rest/screenings'
 
 require 'finapps/rest/plaid/plaid_resources'
 require 'finapps/rest/plaid/plaid_webhooks'

data/lib/finapps/rest/client.rb

@@ -37,6 +37,7 @@ module FinApps
         portfolios_consumers
         portfolio_reports
         products
+        screenings
         sessions
         signed_documents_downloads
         tenant_settings

data/lib/finapps/rest/documents_orders.rb

@@ -17,7 +17,12 @@ module FinApps
 
       def show(id)
         not_blank(id, :order_id)
-        super(id, "documents/orders/#{id}")
+
+        if matches_token_format?(id)
+          show_by_token id
+        else
+          show_by_id id
+        end
       end
 
       def create(params)
@@ -45,6 +50,20 @@ module FinApps
 
       private
 
+      def show_by_id(id)
+        path = "documents/orders/#{id}"
+        send_request path, :get
+      end
+
+      def show_by_token(jwt)
+        path = "documents/retrieve_order?token=#{jwt}"
+        send_request path, :get
+      end
+
+      def matches_token_format?(str)
+        str.match(/^.+\..+\..+$/)
+      end
+
       def build_filter(params)
         search_query(params[:searchTerm])
           .merge(consumer_query(params[:consumer]))

data/lib/finapps/rest/documents_orders_notifications.rb

@@ -3,11 +3,11 @@
 module FinApps
   module REST
     class DocumentsOrdersNotifications < FinAppsCore::REST::Resources
-      def create(id)
+      def create(id, params = [])
         not_blank(id, :id)
 
         path = "documents/orders/#{ERB::Util.url_encode(id)}/notify"
-        super nil, path
+        super params, path
       end
     end
   end

data/lib/finapps/rest/documents_uploads.rb

@@ -18,6 +18,14 @@ module FinApps
         not_blank(doc_id, :doc_id)
         super(nil, "documents/orders/#{order_id}/#{doc_id}")
       end
+
+      def destroy_by_consumer(consumer_id, document_id)
+        not_blank(consumer_id, :consumer_id)
+        not_blank(document_id, :document_id)
+
+        path = "consumers/#{consumer_id}/documents/#{document_id}"
+        send_request path, :delete
+      end
     end
   end
 end

data/lib/finapps/rest/screenings.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../utils/query_builder'
+
+module FinApps
+  module REST
+    class Screenings < FinAppsCore::REST::Resources # :nodoc:
+      include FinApps::Utils::QueryBuilder
+
+      def show(id)
+        not_blank(id, :session_id)
+
+        path = "#{end_point}/#{ERB::Util.url_encode(id)}/resume"
+        super(nil, path)
+      end
+
+      def create(params)
+        not_blank(params, :params)
+        super params
+      end
+
+      def list(params = nil)
+        return super if params.nil?
+        fail FinAppsCore::InvalidArgumentsError, 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_query_path(end_point, params)
+      end
+
+      def update(id, params)
+        not_blank(id, :session_id)
+        not_blank(params, :params)
+
+        path = "#{end_point}/#{ERB::Util.url_encode(id)}"
+        super params, path
+      end
+
+      private
+
+      def build_filter(params)
+        search_query(params[:searchTerm])
+      end
+
+      def search_query(term)
+        return {} unless term
+
+        query = search_query_object(term)
+        {"$or": query}
+      end
+
+      def search_query_object(term)
+        [
+          {"consumer.public_id": term},
+          {"consumer.email": term}
+        ]
+      end
+    end
+  end
+end

data/lib/finapps/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinApps
-  VERSION = '5.0.41'
+  VERSION = '5.0.47'
 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_notifications_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe FinApps::REST::DocumentsOrdersNotifications do
     end
 
     context 'when invalid id is provided' do
-      let(:create) { subject.create(:invalid_id) }
+      let(:create) { subject.create(:invalid_id, ['1234']) }
       let(:results) { create[RESULTS] }
       let(:error_messages) { create[ERROR_MESSAGES] }
 
@@ -30,7 +30,7 @@ RSpec.describe FinApps::REST::DocumentsOrdersNotifications do
     end
 
     context 'with valid id' do
-      let(:create) { subject.create(:valid_id) }
+      let(:create) { subject.create(:valid_id, ['1234']) }
       let(:results) { create[RESULTS] }
       let(:error_messages) { create[ERROR_MESSAGES] }
 

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) }
 
@@ -134,14 +126,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
 

data/spec/rest/documents_uploads_spec.rb

@@ -101,4 +101,57 @@ RSpec.describe FinApps::REST::DocumentsUploads do
       end
     end
   end
+
+  describe '#destroy_by_consumer' do
+    subject(:destroy_by_consumer) do
+      described_class.new(client).destroy_by_consumer(consumer_id, document_id)
+    end
+
+    let(:results) { destroy_by_consumer[0] }
+    let(:error_messages) { destroy_by_consumer[1] }
+
+    context 'with valid params' do
+      let(:consumer_id) { :valid_consumer_id }
+      let(:document_id) { :valid_document_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 consumer_id' do
+      let(:consumer_id) { :invalid_consumer_id }
+      let(:document_id) { :valid_document_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 document id' do
+      let(:consumer_id) { :valid_consumer_id }
+      let(:document_id) { :invalid_document_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(:consumer_id) { nil }
+      let(:document_id) { nil }
+
+      it do
+        expect { destroy_by_consumer }.to raise_error(
+          FinAppsCore::MissingArgumentsError
+        )
+      end
+    end
+  end
 end

data/spec/rest/screenings_spec.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::Screenings do
+  include SpecHelpers::Client
+
+  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: '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) }
+
+    let(:results) { show[0] }
+    let(:error_messages) { show[1] }
+
+    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 '#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
+        {
+          "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) { {} }
+    let(:results) { update[0] }
+    let(:error_messages) { update[1] }
+
+    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
+end