finapps 5.0.43 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25bea095f4796915e3b73d50300279a31fd052ca797da34c91a41078f9eecc2b
-  data.tar.gz: 2f4123341bbc2703a26d8ad361428fb050a06c797390d7b57f2b67f07bef90de
+  metadata.gz: 376f28da5e635a8ad2bb605ed938fd3c27d06d826818a8b050e0bcc5cf3ffb62
+  data.tar.gz: e1a10a00165e243ce8b8558efcc3e666f9f06c6f1a2344004c5f5f0182b15bd8
 SHA512:
-  metadata.gz: 03c8eccc181f51654a07bad7769ce759707d6f6a54a21a806ce0b924ef7bce7ee17c1f27751a86f9659d83e6e7005988dd48bad3d51127bc1957f6764a392116
-  data.tar.gz: 01205c7a1e01a4267d5dd9ad4e10789872a2e6bf47e29c354ed2c9939c806e01bdfa00b1a1c1c36012397cbc6b235760c99486f8b3f71f17c912ad6e458cf059
+  metadata.gz: b26f301279eefa97fbf482adb264d403de9978146513519916b6cfd7f7d2b8f16a85bc7abddc2254b33ee0de9e5e92897546f4c16e799d6e91374863a9636457
+  data.tar.gz: d2c9335df63d6021e1e825bbfd5605dcbf3c969b691d0ac991d68dcbcffb2a0c10cf0c3a21f6c5ab2a4b678bf77603771f80a1161e8d36889e1f171ea8963d80

data/.github/workflows/ci.yaml

@@ -0,0 +1,47 @@
+name: Continuous Integration
+
+on: 
+  push: 
+    paths-ignore:
+      - ".github/**"
+      - ".VERSION"
+  pull_request:
+    paths-ignore:
+      - ".github/**"
+      - ".VERSION"
+jobs:
+  tests:
+    if: "!contains(github.event.head_commit.message, 'skip ci')"
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v2
+
+      - name: Install required ruby
+        uses: ruby/setup-ruby@v1
+
+      - name: Setup cache key and directory for gems cache
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os  }}-gems-${{ hashFiles('**/Gemfile.lock')  }}
+          restore-keys: |
+            ${{ runner.os  }}-gems-
+
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle config set jobs 4
+          bundle config set retry 3
+          bundle install
+
+      - name: Run rubocop
+        run: | 
+          bundle exec rubocop --parallel
+
+      - name: Run tests
+        run: bundle exec rspec

data/.github/workflows/release.yml

@@ -2,53 +2,53 @@ name: Bump version and Release
 on:
   release:
     types: [published]
-          
+
 jobs:
   release:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: true
 
-    steps:
-    - uses: actions/checkout@master
-      with:
-        persist-credentials: false
-        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+    steps: 
+      - name: Checkout source code
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
+
+      - name: Install required ruby version
+        uses: ruby/setup-ruby@v1 
+
+      - name: Get version from latest tag
+        id: get_version
+        uses: battila7/get-version-action@v2
+
+      - 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 }}
 
-    - uses: actions/setup-ruby@v1
-      with: 
-        ruby-version: '2.6'
-        
-    - name: Get version from latest tag
-      id: get_version
-      uses: battila7/get-version-action@v2
+      - 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: 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 }}
-        
-    - 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: |
-        set +x
-        mkdir -p ~/.gem
-        cat << EOF > ~/.gem/credentials
-        ---
-        :rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}
-        EOF
-        chmod 0600 ~/.gem/credentials
-        set -x
-        gem release
+      - name: Release gem to rubygems.org    
+        run: |
+          set +x
+          mkdir -p ~/.gem
+          cat << EOF > ~/.gem/credentials
+          ---
+          :rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}
+          EOF
+          chmod 0600 ~/.gem/credentials
+          set -x
+          gem release

data/.rubocop.yml

@@ -48,7 +48,7 @@ Metrics/ClassLength:
     - app/controllers/orders_controller.rb
     - app/models/order.rb
 Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context']
+  IgnoredMethods: ['describe', 'context']
   Exclude:
     - config/environments/**/**
     - Guardfile

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.3
+ruby-2.7.2

data/Guardfile

@@ -17,7 +17,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'

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,19 +20,20 @@ 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.15'
 
   spec.add_development_dependency 'bundler',                    '~> 2.0',   '>= 2.0.2'
   spec.add_development_dependency 'codeclimate-test-reporter',  '~> 1.0',   '>= 1.0.9'
   spec.add_development_dependency 'guard',                      '~> 2.16',  '>= 2.16.1'
   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 'sinatra',                    '~> 2.0',   '>= 2.0.8'
-  spec.add_development_dependency 'webmock',                    '~> 3.8',   '>= 3.8.0'
+  spec.add_development_dependency 'rspec',                      '~> 3.10',  '>= 3.10.0'
+  spec.add_development_dependency 'rubocop',                    '~> 1.9',   '>= 1.9.1'
+  spec.add_development_dependency 'rubocop-performance',        '~> 1.9',   '>= 1.9.2'
+  spec.add_development_dependency 'rubocop-rake',               '~> 0.5',   '>= 0.5.1'
+  spec.add_development_dependency 'rubocop-rspec',              '~> 2.2',   '>= 2.2.0'
+  spec.add_development_dependency 'sinatra',                    '~> 2.1',   '>= 2.1.0'
+  spec.add_development_dependency 'webmock',                    '~> 3.11',  '>= 3.11.2'
 
   spec.extra_rdoc_files = %w[README.md LICENSE.txt]
   spec.rdoc_options = %w[--line-numbers --inline-source --title finapps-ruby --main README.md]

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
@@ -82,7 +83,7 @@ module FinApps
 
       def camelize(term)
         string = term.to_s
-        string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+        string = string.sub(/^[a-z\d]*/) { Regexp.last_match(0).capitalize }
         string.gsub(%r{(?:_|(/))([a-z\d]*)}) do
           Regexp.last_match(2).capitalize.to_s
         end

data/lib/finapps/rest/consumers.rb

@@ -62,9 +62,9 @@ module FinApps
 
       def with_space_search(term)
         [
-          {"email": term},
-          {"first_name": term},
-          {"last_name": term}
+          {email: term},
+          {first_name: term},
+          {last_name: term}
         ]
       end
 
@@ -72,8 +72,8 @@ module FinApps
         search_arr = []
         if /\s/.match?(term)
           term.split.each do |t|
-            search_arr.append("first_name": t)
-            search_arr.append("last_name": t)
+            search_arr.append(first_name: t)
+            search_arr.append(last_name: t)
           end
         end
         search_arr

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]))
@@ -76,7 +95,7 @@ module FinApps
           {"applicant.first_name": term},
           {"applicant.last_name": term},
           {
-            "reference_no": {
+            reference_no: {
               "$regex": "^#{term}", "$options": 'i'
             }
           }
@@ -86,7 +105,7 @@ module FinApps
       def tag_query(tag)
         return {} unless tag
 
-        {"tag": tag.empty? ? nil : tag}
+        {tag: tag.empty? ? nil : tag}
       end
 
       def status_query(status)
@@ -98,7 +117,7 @@ module FinApps
       def consumer_query(consumer)
         return {} unless consumer
 
-        {"consumer_id": consumer.empty? ? nil : consumer}
+        {consumer_id: consumer.empty? ? nil : consumer}
       end
     end
   end

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/operators.rb

@@ -64,14 +64,14 @@ module FinApps
       end
 
       def search_query(term)
-        {"last_name": term}
+        {last_name: term}
       end
 
       def role_query(role)
         if role.is_a?(Array)
-          {"role": {"$in": role.map(&:to_i)}}
+          {role: {"$in": role.map(&:to_i)}}
         else
-          {"role": role.to_i}
+          {role: role.to_i}
         end
       end
     end

data/lib/finapps/rest/orders.rb

@@ -81,7 +81,7 @@ module FinApps
       end
 
       def search_query_object(term)
-        [{"public_id": {"$regex": "^#{term}", "$options": 'i'}},
+        [{public_id: {"$regex": "^#{term}", "$options": 'i'}},
          {"assignment.last_name": term},
          {"applicant.first_name": term},
          {"applicant.last_name": term},
@@ -95,9 +95,9 @@ module FinApps
       def status_query(status)
         if status
           if status.is_a?(Array)
-            {"status": {"$in": status.map(&:to_i)}}
+            {status: {"$in": status.map(&:to_i)}}
           else
-            {"status": status.to_i}
+            {status: status.to_i}
           end
         else
           {}
@@ -115,7 +115,7 @@ module FinApps
 
       def consumer_query(consumer)
         if consumer
-          {"consumer_id": consumer.empty? ? nil : consumer}
+          {consumer_id: consumer.empty? ? nil : consumer}
         else
           {}
         end
@@ -125,8 +125,8 @@ module FinApps
         if !search_term && !nil_or_empty?(relation)
           {
             "$or": [
-              {"public_id": {"$in": relation}},
-              {"original_order_id": {"$in": relation}}
+              {public_id: {"$in": relation}},
+              {original_order_id: {"$in": relation}}
             ]
           }
         else

data/lib/finapps/rest/screenings.rb

@@ -0,0 +1,64 @@
+# 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
+
+      def destroy(id)
+        not_blank(id, :session_id)
+
+        super
+      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