belvo 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a629a7752ddbb1913f5313eeab072774c4ecd36748fb3cdf306a78f2bd4f6bbb
-  data.tar.gz: fd1d6c751d71663622e94f076ab1b4fbd606fdafdfc62ca5e1574d6cf4b17ef4
+  metadata.gz: 0de1101793b44dc5c12a680162aa516f45b4866bd5279d492fc83f3b31cdb39f
+  data.tar.gz: dfda3b216359c9d6efd79ee5a2f6785b2256cada2a5cb6e65f77070eb9631fe8
 SHA512:
-  metadata.gz: 2d2c41f8f976ec9a67622b12ed5f5ff1ef5373b1f7d170cd17a85f341e1313028be9f323f57102fc8f5c105c56f4572e1960fc45f051ed4fe210e0c90c13d195
-  data.tar.gz: ff9552fe45ccf2ea98bf53c2392b8e68120e4c965aa9f2843132f664bf24bfd7c7b9ad5c60eb54e8b0f29d7dda2dddf2d14a25b44890939127a5e1066ada95ab
+  metadata.gz: 27f919f95f5d7dcc9aece0bfae1a95f4e6227bf5cccce8a38547498ad290ad4bfb9d1478fee515a8e8c0e748a23a85a27ca8085ac7bc1a2c0fd4e71aa3dcb65a
+  data.tar.gz: 5a509f0079539806d3b56780dc9372ff340689712cc29c6cff5b457ce20a76d56628f68979b2aea036312f6c9184647cc149f74140d8d98176074325d8a31453

data/.github/workflows/danger-pr-reviews-custom.yml

@@ -0,0 +1,52 @@
+name: Run Danger (Custom)
+
+on: [pull_request]
+
+jobs:
+  build:
+    name: Run Danger (Custom)
+    runs-on: ubuntu-latest
+    if: ${{ github.actor != 'dependabot[bot]' }}
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 50
+
+      # Setup ruby
+      - name: Set up Ruby 3.2
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+
+      # Install the right bundler version
+      - name: Install bundler
+        run: gem install bundler
+
+      # Cache dependencies
+      - name: Cache ruby dependencies
+        id: cache-ruby
+        uses: actions/cache@v3
+        with:
+          path: vendor/bundle
+          key: union-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            union-gems-
+
+      # Install dependencies on cache miss
+      - name: Install ruby dependencies
+        if: steps.cache-ruby.outputs.cache-hit != 'true'
+        run: |
+          bundle config --local without "documentation"
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      # Run danger
+      - name: Run danger
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          bundle config path vendor/bundle
+          bundle exec danger --dangerfile=Dangerfile.custom

data/.github/workflows/danger-pr-reviews.yml

@@ -6,12 +6,13 @@ jobs:
   build:
     name: Run Danger
     runs-on: ubuntu-latest
+    if: ${{ github.actor != 'dependabot[bot]' }}
 
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2
         with:
-          fetch-depth: 10
+          fetch-depth: 50
 
       # Setup ruby
       - name: Set up Ruby 3.2
@@ -27,18 +28,21 @@ jobs:
       # Cache dependencies
       - name: Cache ruby dependencies
         id: cache-ruby
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: vendor/bundle
           key: union-gems-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
             union-gems-
+
       # Install dependencies on cache miss
       - name: Install ruby dependencies
         if: steps.cache-ruby.outputs.cache-hit != 'true'
         run: |
+          bundle config --local without "documentation"
           bundle config path vendor/bundle
-          bundle install --jobs 4 --retry 3 --without=documentation
+          bundle install --jobs 4 --retry 3
+
       # Run danger
       - name: Run danger
         env:
@@ -46,4 +50,3 @@ jobs:
         run: |
           bundle config path vendor/bundle
           bundle exec danger
-

data/.github/workflows/generate-docs.yml

@@ -11,9 +11,10 @@ jobs:
       - name: Checkout Belvo Ruby SDK repo
         uses: actions/checkout@v2
       - name: Set up Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "2.7"
+          ruby-version: 3.2
+          bundler-cache: true
       - name: Install required gem dependencies
         run: gem install yard --no-document
       - name: Build RUBY SDK docs with YARD

data/Dangerfile

@@ -1,21 +1,27 @@
-# rubocop:disable all
-# Mainly to encourage writing up some reasoning about the PR, rather than
-# just leaving a title
-fail "Please provide a short summary in the PR description :page_with_curl:" if github.pr_body.length < 10
+# frozen_string_literal: true
 
-# The title should include the correct prefix tag
-if !github.pr_title.match(/^\[(?:Fixed|Added|Changed|Removed|Security|Other)\]/)
-	fail "Please provide a valid PR title label: [Added]/[Fixed]/[Changed]/[Removed]/[Security]/[Other]"
+##########################################################################
+# THIS FILE IS OWNED BY SECURITY CHANGES TO THIS FILE ARE MADE CENTRALLY #
+#          CONTACT SECURITY@BELVO.COM or SLACK #ASK-SECURITY             #
+##########################################################################
+
+# Provide a description
+if github.pr_body.length < 10
+  raise 'Please provide a short summary in the PR description :page_with_curl:'
 end
 
-# The title should include the JIRA ticket unless is a dependabot PR
-if github.pr_labels.include?("dependencies")
-	message ("PR autogenerated by dependabot")
-elsif !github.pr_title.match(/^\[.*\]\s?\[BEL-\d+\]/)
-	fail "Please provide a valid Jira ticket ID associated to this PR: [BEL-XXXX]. If you do not have any associated Jira ticket, just use [BEL-XXXX]"
+# The title has to include a JIRA ticket unless is a dependabot PR or SNYK
+if github.pr_labels.include?('dependencies')
+  message 'PR autogenerated by dependabot'
+elsif github.pr_title =~ /\[Snyk\]/
+  message 'PR generated by Snyk'
+elsif github.pr_title !~ /\[[A-Z]{1,10}-[0-9]{1,5}\]/
+  raise 'Please provide a valid Jira ticket ID associated to this PR'\
+   '(e.g. [BEL-XXXXX]'
 end
 
-warn("PR is classed as Work in Progress", sticky: false) if github.pr_title.include? "[WIP]"
+if github.pr_title.include? '[WIP]'
+  warn('PR is classed as Work in Progress', sticky: false)
+end
 
-message("One approval required for merging :smiley_cat: :smiley_cat:")
-# rubocop:enable all
+message('One approval required for merging')

data/Dangerfile.custom

@@ -0,0 +1,6 @@
+# The PR title should include the correct label
+if !github.pr_title.match(/\[Snyk\]/) &&
+	!github.pr_labels.include?("dependencies") &&
+	!github.pr_title.match(/^\[(?:Added|Changed|Docs|Fixed|Migrations|Other|Removed|Security)\]/)
+	fail "Please provide a valid PR title label: [Added]/[Changed]/[Docs]/[Fixed]/[Migrations]/[Other]/[Removed]/[Security]."
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (1.4.0)
+    belvo (1.6.0)
       faraday
       faraday_middleware
       typhoeus
@@ -42,7 +42,7 @@ GEM
       terminal-table (~> 1)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    ethon (0.15.0)
+    ethon (0.16.0)
       ffi (>= 1.15.0)
     faraday (1.10.0)
       faraday-em_http (~> 1.0)
@@ -72,7 +72,8 @@ GEM
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
     ffi (1.15.5)
-    git (1.11.0)
+    git (1.17.2)
+      addressable (~> 2.8)
       rchardet (~> 1.8)
     hashdiff (1.0.1)
     jaro_winkler (1.5.4)

data/README.md

@@ -117,7 +117,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 To release a new version:
 - Create a new branch from master.
 - Update the version number in `version.rb`
-- Run `bundle exec rake install` to update `Gemfile.lock` version
+- Run `bundle exec rake install` to update `Gemfile.lock` version (might need sudo)
 - Create a new pull request for the new version.
 - Once the new version is merged in `master`, create a `tag` matching the new version.
 

data/lib/belvo/options.rb

@@ -214,4 +214,12 @@ module Belvo
   # @!attribute token [rw] OTP token required by the institution
   class InvestmentsPortfolioOptions < Faraday::Options.new(:token, :save_data)
   end
+
+  # @!class EmploymentRecordsOptions < Faraday::Options
+  # Contains configurable properties of an Employment Record
+  # @!attribute save_data [rw] Should data be persisted or not.
+  # @!attribute attach_pdf [rw] Should the PDF file be included in the
+  #   response or not.
+  class EmploymentRecordsOptions < Faraday::Options.new(:save_data, :attach_pdf)
+  end
 end

data/lib/belvo/resources.rb

@@ -655,4 +655,29 @@ module Belvo
       @session.post(@endpoint, body)
     end
   end
+
+  # Employment records
+  class EmploymentRecords < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'api/employment-records/'
+    end
+
+    # Retrieve employment records from an existing government link
+    # @param link [String] Link UUID
+    # @param options [EmploymentRecordsOptions] Configurable properties
+    # @return [Hash] created employment records details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = EmploymentRecordsOptions.from(options)
+      body = {
+        link: link,
+        save_data: options.save_data || true,
+        attach_pdf: options.attach_pdf
+      }.merge(options)
+
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+  end
 end

data/lib/belvo/version.rb

@@ -2,5 +2,5 @@
 
 module Belvo
   # belvo-ruby current version
-  VERSION = '1.4.0'
+  VERSION = '1.6.0'
 end

data/lib/belvo.rb

@@ -139,5 +139,11 @@ module Belvo
     def investments_portfolio
       @investments_portfolio = InvestmentsPortfolio.new @session
     end
+
+    # Provides access to EmploymentRecords resource
+    # @return [EmploymentRecords]
+    def employment_records
+      @employment_records = EmploymentRecords.new @session
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -151,6 +151,7 @@ files:
 - ".github/CODEOWNERS"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
+- ".github/workflows/danger-pr-reviews-custom.yml"
 - ".github/workflows/danger-pr-reviews.yml"
 - ".github/workflows/generate-docs.yml"
 - ".gitignore"
@@ -158,6 +159,7 @@ files:
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Dangerfile
+- Dangerfile.custom
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -173,6 +175,7 @@ files:
 - lib/belvo/resources.rb
 - lib/belvo/utils.rb
 - lib/belvo/version.rb
+- specs.4.8.gz
 homepage: https://github.com/belvo-finance/belvo-ruby
 licenses:
 - MIT