finapps 5.0.35 → 5.0.44

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4756aafb56941b9eaf0609a1aa07d9eae9b3485e70a10bf1ab7590cc973654d1
-  data.tar.gz: 0e55b4ed791fc263027a21b6193ca025778e983fb0742006111b9fc1c5d88e4d
+  metadata.gz: 94ef2ce4cd675c162a8b7d7c932fd85235fd4f30f5553fd2f829f89768d35451
+  data.tar.gz: a3bc58dc9f244eb8300a2e49fd9e24a429bcaf3211fb4468686e3d8db14c5328
 SHA512:
-  metadata.gz: 90031e4f43d5a3fda8f4f3f2df53e7ecb8a5e27ab53830f79aaf80ab981b293b8890ad3e2bf8a31ebc210dcaf37f29fbcc1442fb139ee463b465243223381393
-  data.tar.gz: 56d79d89f1a40e4ee1fff5b58ad8e49f762375c7ea6a4911a3e149004272eba89fe3e6348653a49f75a2bf1cd6a1f41ef4e8c20af6857c0e75af76c818b88467
+  metadata.gz: 1a250e599314beab25f3bbd0d2d2781f9af75ff59ef28bc130a748456ae3bbef9516b70c51ee91c465bbc96b55d69f74f190c9a5b09ab3d703f6efb23d43a378
+  data.tar.gz: 759cbe18313cbaa105d9ea7439e962215a3c5be7a773c2662ee63dddb315adafcd8a52b3508eb05982dedf986642a9374972aad52638e875479cfc269b9171ba

data/.github/release-drafter.yml

@@ -0,0 +1,49 @@
+name-template: 'version $RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: 'Added'
+    labels: 'enhancement'
+  - title: 'Changed'
+    labels: 'change' 
+  - title: 'Deprecated'
+    labels: 'deprecated' 
+  - title: 'Removed'
+    labels: 'removed'     
+  - title: 'Fixed'
+    labels: 'bug'
+  - title: 'Security'
+    label: 'dependencies'
+  - title: 'Documentation updates'
+    label: 'documentation'
+  - title: 'Maintenance'
+    labels: 'internal'  
+      
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+  
+exclude-labels:
+  - reverted
+  - no-changelog
+  - skip-changelog
+  - invalid
+  
+template: |
+  ## [$RESOLVED_VERSION](https://github.com/finapps/ruby-client/compare/$PREVIOUS_TAG...$RESOLVED_VERSION)
+  $CHANGES
+
+replacers:
+  - search: '/CVE-(\d{4})-(\d+)/g'
+    replace: 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2'
+  - search: '@dependabot-preview'
+    replace: '@dependabot'

data/.github/workflows/main.yaml

@@ -1,9 +1,10 @@
-name: Main
+name: Continuous Integration
 
 on: [push, pull_request]
 
 jobs:
   ci:
+    if: "!contains(github.event.head_commit.message, 'skip ci')"
     runs-on: ubuntu-latest
 
     strategy:
@@ -17,7 +18,7 @@ jobs:
         with:
           ruby-version: '2.6'
 
-      - uses: actions/cache@v1
+      - uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: ${{ runner.os  }}-gems-${{ hashFiles('**/Gemfile.lock')  }}
@@ -26,7 +27,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-drafter.yml

@@ -0,0 +1,15 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  update_release_draft:
+    if: "!contains(github.event.head_commit.message, 'skip ci')"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,54 @@
+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
+
+    - 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: 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

data/.github/workflows/verify-pr-labeled.yml

@@ -0,0 +1,14 @@
+name: "Require PR labels"
+
+on:
+  pull_request:
+    types: [opened, labeled, unlabeled, synchronize]
+jobs:
+  label:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mheap/github-action-required-labels@v1
+        with:
+          mode: exactly
+          count: 1
+          labels: "bug, change, enhancement"       

data/.rubocop.yml

@@ -10,6 +10,7 @@ AllCops:
     - "vendor/**/*"
     - "bin/**/*"
   CacheRootDirectory: tmp
+  NewCops: enable
 
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
@@ -69,6 +70,8 @@ Naming/PredicateName:
 
 RSpec/FilePath:
   Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false
     
 Style/RedundantRegexpCharacterClass:
   Enabled: true
@@ -138,18 +141,8 @@ Style/OneLineConditional:
   Description: Favor the ternary operator(?:) over if/then/else/end constructs.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
   Enabled: false
-Style/ExponentialNotation:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-Style/RedundantFetchBlock:
-  Enabled: true
-Style/SlicingWithRange:
-  Enabled: true
+Style/OptionalBooleanParameter:
+  Enabled: false
 
 RSpec/NestedGroups:
   Max: 5

data/.rubocop_todo.yml

@@ -17,7 +17,7 @@ Metrics/BlockLength:
 # Configuration parameters: CountComments.
 # fake_api.rb - leaving as is intentionally
 Metrics/ClassLength:
-  Max: 431
+  Max: 442
 
 # Offense count: 5
 # Configuration parameters: Max.

data/RELEASES.md

@@ -1,3 +1,12 @@
+## [5.0.36] - 2020-08-05
+
+### Changed
+* Add upload endpoints to support dashboard ([#309][i309])
+
+[i309]: https://github.com/finapps/tenant-dashboard-react/issues/309
+
+[5.0.36]: https://github.com/finapps/ruby-client/compare/5.0.35...5.0.36
+
 ## [5.0.35] - 2020-07-09
 
 ### Changed

data/finapps.gemspec

@@ -24,7 +24,6 @@ Gem::Specification.new do |spec|
 
   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 'gem-release',                '~> 2.1',   '>= 2.1.1'
   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'

data/lib/finapps.rb

@@ -30,7 +30,9 @@ require 'finapps/rest/portfolios_consumers'
 require 'finapps/rest/consumers_portfolios'
 require 'finapps/rest/portfolio_reports'
 require 'finapps/rest/documents_orders'
+require 'finapps/rest/documents_uploads'
 require 'finapps/rest/esign_templates'
+require 'finapps/rest/documents_upload_types'
 require 'finapps/rest/signed_documents_downloads'
 require 'finapps/rest/documents_orders_notifications'
 

data/lib/finapps/rest/client.rb

@@ -13,6 +13,8 @@ module FinApps
         consumers_portfolios
         documents_orders
         documents_orders_notifications
+        documents_upload_types
+        documents_uploads
         esign_templates
         orders
         order_assignments

data/lib/finapps/rest/documents_orders.rb

@@ -33,7 +33,7 @@ module FinApps
 
       def destroy(id)
         not_blank(id, :order_id)
-        super(id, "documents/orders/#{id}")
+        super(nil, "documents/orders/#{id}")
       end
 
       def show_signing_url(order_id, signature_id)

data/lib/finapps/rest/documents_upload_types.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class DocumentsUploadTypes < FinAppsCore::REST::Resources
+      def list
+        super('documents/upload_types')
+      end
+    end
+  end
+end

data/lib/finapps/rest/documents_uploads.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class DocumentsUploads < FinAppsCore::REST::Resources
+      def show(consumer_id, doc_id, thumbnail = false)
+        not_blank(consumer_id, :consumer_id)
+        not_blank(doc_id, :doc_id)
+
+        path =
+          "consumers/#{ERB::Util.url_encode(consumer_id)}/"\
+        "documents/#{ERB::Util.url_encode(doc_id)}?thumbnail=#{thumbnail}"
+        super(nil, path)
+      end
+
+      def destroy(order_id, doc_id)
+        not_blank(order_id, :order_id)
+        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/version.rb

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

data/spec/rest/documents_upload_types_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::DocumentsUploadTypes do
+  include SpecHelpers::Client
+  subject(:upload_types) { described_class.new(client).list }
+
+  let(:results) { upload_types[0] }
+
+  describe '#list' do
+    context 'when called' do
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('performs a get and returns the response') do
+        expect(results[0]).to have_key(:type)
+      end
+    end
+  end
+end

data/spec/rest/documents_uploads_spec.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::DocumentsUploads do
+  include SpecHelpers::Client
+
+  describe '#show' do
+    let(:upload) { described_class.new(client) }
+
+    context 'when missing doc id' do
+      subject(:show) { upload.show(:consumer_id, nil) }
+
+      it 'raises an error' do
+        expect { show }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+    end
+
+    context 'when missing consumer id' do
+      subject(:show) { upload.show(nil, :doc_id) }
+
+      it 'raises an error' do
+        expect { show }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+    end
+
+    context 'when thumbnail is not included' do
+      subject(:show) do
+        upload.show(
+          :consumer_id,
+          :doc_id
+        )
+      end
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+    end
+
+    context 'when thumbnail is included' do
+      subject(:show) do
+        upload.show(
+          :consumer_id,
+          :doc_id,
+          true
+        )
+      end
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+    end
+  end
+
+  describe '#destroy' do
+    subject(:destroy) { described_class.new(client).destroy(order_id, doc_id) }
+
+    let(:results) { destroy[0] }
+    let(:error_messages) { destroy[1] }
+
+    context 'with valid id' do
+      let(:order_id) { :valid_order_id }
+      let(:doc_id) { :valid_doc_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 order id' do
+      let(:order_id) { :invalid_order_id }
+      let(:doc_id) { :valid_doc_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 doc id' do
+      let(:order_id) { :valid_order_id }
+      let(:doc_id) { :invalid_doc_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(:order_id) { nil }
+      let(:doc_id) { nil }
+
+      it do
+        expect { destroy }.to raise_error(
+          FinAppsCore::MissingArgumentsError
+        )
+      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