belvo 0.10.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8e956f90ab794d8165e888ebb059212e3e7ea4ee2f6ca6526a6223473086fd9
-  data.tar.gz: c177f509945811c6df6f64367270118763cf48bbc3728dbcd4c8b880ee7d79b3
+  metadata.gz: '038fbaeb161f1c341855ded020989160dc8ebbbcea33f5fe05fa0c92c81d0bcf'
+  data.tar.gz: 4eee5f78d13eb4fff6a3a01ed50aa673a4b62b0bb10b45b86795d8e980f1a48d
 SHA512:
-  metadata.gz: 9a09abefb67fad3b3bc8244dfff5a93f49069ddb4a213e833d27724a41a3276683c6e23d8c386790efe5bd9ea07a6f4ff10d76dbd7eecb384cf5c76739e6f063
-  data.tar.gz: 87cd5325266f6987429d0061f7589cf7cd617164171f0126da439672d0e2f03256a7608d7deec25e61f1ac1705173cea4ca25dc03805253345bcec8b465dbdd4
+  metadata.gz: 4845b72c9a053c7bc8fabe97d6990cd1006fc75b4493f42944aac21cc3aea72860a2d9d7ab0cc0ae56f1a68f465c9c0aff1c9ca76c39e3ee82a4f638862f955b
+  data.tar.gz: d41485f0c38659baa74b675d9220f3f1a07086d62c0ead42c886e3dedd06d0c4bcaab7ee878cc5cbe1dcf06e01eb7cd0d71413925be407c26af1617b596e1e1f

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

@@ -0,0 +1,48 @@
+name: Run Danger
+
+on: [pull_request]
+
+jobs:
+  build:
+    name: Run Danger
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+
+      # Setup ruby
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      # Install the right bundler version
+      - name: Install bundler
+        run: gem install bundler
+
+      # Cache dependencies
+      - name: Cache ruby dependencies
+        id: cache-ruby
+        uses: actions/cache@v2
+        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 path vendor/bundle
+          bundle install --jobs 4 --retry 3 --without=documentation
+      # Run danger
+      - name: Run danger
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          bundle config path vendor/bundle
+          bundle exec danger
+

data/Dangerfile

@@ -0,0 +1,21 @@
+# 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
+
+# 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]"
+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]"
+end
+
+warn("PR is classed as Work in Progress", sticky: false) if github.pr_title.include? "[WIP]"
+
+message("One approval required for merging :smiley_cat: :smiley_cat:")
+# rubocop:enable all

data/Gemfile

@@ -1,3 +1,4 @@
+# rubocop:disable all
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
@@ -13,4 +14,6 @@ gem 'rspec', '~> 3.0'
 gem 'rubocop', '~> 0.81.0', require: false
 gem 'rubocop-rspec', require: false
 gem 'typhoeus'
+gem 'danger', '8.2.1'
 gem 'webmock'
+# rubocop:enable all

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (0.10.0)
+    belvo (0.14.0)
       faraday
       faraday_middleware
       typhoeus
@@ -12,6 +12,14 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -19,6 +27,19 @@ GEM
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
     crack (0.4.4)
+    danger (8.2.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
     diff-lcs (1.4.4)
     docile (1.3.2)
     ethon (0.12.0)
@@ -26,20 +47,35 @@ GEM
     faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     ffi (1.13.1)
+    git (1.8.1)
+      rchardet (~> 1.8)
     hashdiff (1.0.1)
     jaro_winkler (1.5.4)
     json (2.3.1)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     multipart-post (2.1.1)
+    nap (1.1.0)
+    no_proxy_fix (0.1.2)
+    octokit (4.21.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
     parallel (1.20.0)
     parser (2.7.2.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (12.3.3)
-    rexml (3.2.4)
+    rchardet (1.8.0)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -65,6 +101,9 @@ GEM
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -73,6 +112,8 @@ GEM
     sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
     thor (1.0.1)
     tins (1.26.0)
       sync
@@ -90,6 +131,7 @@ PLATFORMS
 DEPENDENCIES
   belvo!
   coveralls
+  danger (= 8.2.1)
   faraday
   faraday_middleware
   rake (~> 12.0)

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Belvo
+Copyright (c) 2020 Belvo Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -73,6 +73,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/belvo-finance/belvo-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/belvo-finance/belvo-ruby/blob/master/CODE_OF_CONDUCT.md).
 
+If you wish to submit a pull request, please be sure check the items on this list:
+- [ ] Tests related to the changed code were executed
+- [ ] The source code has been coded following the OWASP security best practices (https://owasp.org/www-pdf-archive/OWASP_SCP_Quick_Reference_Guide_v2.pdf).
+- [ ] Commit message properly labeled
+- [ ] There is a ticket associated to each PR. 
+
 
 ## Code of Conduct
 

data/lib/belvo.rb

@@ -3,6 +3,7 @@
 require 'belvo/http'
 require 'belvo/exceptions'
 require 'belvo/resources'
+require 'belvo/utils'
 
 module Belvo
   # Allows easy access to Belvo API servers.
@@ -18,7 +19,11 @@ module Belvo
     # @return [APISession] Authenticated Belvo API session
     def initialize(secret_key_id, secret_key_password, url = nil)
       (belvo_api_url = url) || ENV['BELVO_API_URL']
-      raise BelvoAPIError, 'You need to provide a URL.' if belvo_api_url.nil?
+      belvo_api_url = Environment.get_url(belvo_api_url)
+
+      if belvo_api_url.nil?
+        raise BelvoAPIError, 'You need to provide a URL or a valid environment.'
+      end
 
       @session = Belvo::APISession.new(belvo_api_url)
 

data/lib/belvo/http.rb

@@ -99,8 +99,7 @@ module Belvo
 
         break unless response.body['next']
 
-        path = response.body['next']
-        params = nil
+        params = Faraday::Utils.parse_query URI(response.body['next']).query
       end
     end
 

data/lib/belvo/options.rb

@@ -10,7 +10,6 @@ module Belvo
   # @!attribute username2 [rw] End-user secondary username, if any
   # @!attribute username3 [rw] End-user tertiary username, if any
   # @!attribute password2 [rw] End-user secondary password, if any
-  # @!attribute encryption_key [rw] Custom encryption key
   # @!attribute username_type [rw] Type of the username provided
   class LinkOptions < Faraday::Options.new(
     :access_mode,
@@ -18,10 +17,10 @@ module Belvo
     :username2,
     :username3,
     :password2,
-    :encryption_key,
     :username_type,
     :certificate,
-    :private_key
+    :private_key,
+    :external_id
   )
   end
 
@@ -29,11 +28,9 @@ module Belvo
   # Contains the configurable properties for an Account
   # @!attribute save_data [rw] Should data be persisted or not.
   # @!attribute token [rw] OTP token required by the institution
-  # @!attribute encryption_key [rw] Custom encryption key
   class AccountOptions < Faraday::Options.new(
     :save_data,
-    :token,
-    :encryption_key
+    :token
   )
   end
 
@@ -43,12 +40,10 @@ module Belvo
   # @!attribute account [rw] Account ID (UUID)
   # @!attribute save_data [rw] Should data be persisted or not.
   # @!attribute token [rw] OTP token required by the institution
-  # @!attribute encryption_key [rw] Custom encryption key
   class TransactionOptions < Faraday::Options.new(
     :date_to,
     :account,
     :token,
-    :encryption_key,
     :save_data
   )
   end
@@ -57,8 +52,7 @@ module Belvo
   # Contains configurable properties of an Owner
   # @!attribute save_data [rw] Should data be persisted or not.
   # @!attribute token [rw] OTP token required by the institution
-  # @!attribute encryption_key [rw] Custom encryption key
-  class OwnerOptions < Faraday::Options.new(:token, :encryption_key, :save_data)
+  class OwnerOptions < Faraday::Options.new(:token, :save_data)
   end
 
   # @!class BalanceOptions < Faraday::Options
@@ -67,12 +61,10 @@ module Belvo
   # @!attribute account [rw] Account ID (UUID)
   # @!attribute save_data [rw] Should data be persisted or not.
   # @!attribute token [rw] OTP token required by the institution
-  # @!attribute encryption_key [rw] Custom encryption key
   class BalanceOptions < Faraday::Options.new(
     :date_to,
     :account,
     :token,
-    :encryption_key,
     :save_data
   )
   end
@@ -81,12 +73,10 @@ module Belvo
   # Contains configurable properties of a Statement
   # @!attribute save_data [rw] Should data be persisted or not.
   # @!attribute token [rw] OTP token required by the institution
-  # @!attribute encryption_key [rw] Custom encryption key
   # @!attribute attach_pdf [rw] Should the PDF file be included in the
   #   response or not.
   class StatementOptions < Faraday::Options.new(
     :token,
-    :encryption_key,
     :save_data,
     :attach_pdf
   )
@@ -95,9 +85,7 @@ module Belvo
   # @!class IncomeOptions < Faraday::Options
   # Contains configurable properties of an Income
   # @!attribute save_data [rw] Should data be persisted or not.
-  # @!attribute encryption_key [rw] Custom encryption key
   class IncomeOptions < Faraday::Options.new(
-    :encryption_key,
     :save_data
   )
   end
@@ -106,13 +94,11 @@ module Belvo
   # Contains configurable properties of an Invoice
   # @!attribute save_data [rw] Should data be persisted or not.
   # @!attribute token [rw] OTP token required by the institution
-  # @!attribute encryption_key [rw] Custom encryption key
   # @!attribute attach_xml [rw] Should the XML file be included in the
   #   response or not.
   class InvoiceOptions < Faraday::Options.new(
     :save_data,
     :token,
-    :encryption_key,
     :attach_xml
   )
   end
@@ -121,12 +107,10 @@ module Belvo
   # Contains configurable properties of a TaxComplianceStatus
   # @!attribute save_data [rw] Should data be persisted or not.
   # @!attribute token [rw] OTP token required by the institution
-  # @!attribute encryption_key [rw] Custom encryption key
   # @!attribute attach_pdf [rw] Should the PDF file be included in the
   #   response or not.
   class TaxComplianceStatusOptions < Faraday::Options.new(
     :token,
-    :encryption_key,
     :save_data,
     :attach_pdf
   )
@@ -136,14 +120,15 @@ module Belvo
   # Contains configurable properties of a TaxReturn
   # @!attribute save_data [rw] Should data be persisted or not.
   # @!attribute token [rw] OTP token required by the institution
-  # @!attribute encryption_key [rw] Custom encryption key
   # @!attribute attach_pdf [rw] Should the PDF file be included in the
   #   response or not.
   class TaxReturnOptions < Faraday::Options.new(
     :token,
-    :encryption_key,
     :save_data,
-    :attach_pdf
+    :attach_pdf,
+    :type,
+    :date_from,
+    :date_to
   )
   end
 
@@ -151,12 +136,10 @@ module Belvo
   # Contains configurable properties of a TaxStatus
   # @!attribute save_data [rw] Should data be persisted or not.
   # @!attribute token [rw] OTP token required by the institution
-  # @!attribute encryption_key [rw] Custom encryption key
   # @!attribute attach_pdf [rw] Should the PDF file be included in the
   #   response or not.
   class TaxStatusOptions < Faraday::Options.new(
     :token,
-    :encryption_key,
     :save_data,
     :attach_pdf
   )
@@ -165,9 +148,11 @@ module Belvo
   # Contains configurable properties of a WidgetToken
   # @!attribute scopes [rw] Should have WidgetToken's permssions.
   # @!attribute link [rw] Should the WidgetToken be tied to a specific link.
+  # @!attribute widget [rw] Should have the Widget branding params.
   class WidgetTokenOptions < Faraday::Options.new(
     :scopes,
-    :link
+    :link,
+    :widget
   )
   end
 end

data/lib/belvo/resources.rb

@@ -99,7 +99,7 @@ module Belvo
       @session.post(@endpoint, body)
     end
 
-    # Allows to change password, password2 or setting a custom encryption key
+    # Allows to change password, password2
     # @param id [String] Link UUID
     # @param password [String] End-user password
     # @param password2 [String, nil] End-user secondary password, if any
@@ -114,7 +114,6 @@ module Belvo
         password: password,
         password2: password2,
         token: options.token,
-        encryption_key: options.encryption_key,
         username_type: options.username_type,
         certificate: options.certificate,
         private_key: options.private_key
@@ -134,6 +133,24 @@ module Belvo
       }
       @session.token(@endpoint, id, body)
     end
+
+    # Patch an existing link
+    # @param id [String] Link UUID
+    # @param options [LinkOptions] Configurable properties
+    # @return [Hash] created link details
+    # @raise [RequestError] If response code is different than 2XX
+    def patch(
+      id:,
+      options: nil
+    )
+      options = LinkOptions.from(options)
+      body = {
+        access_mode: options.access_mode
+      }.merge(options)
+      body = clean body: body
+      resource_path = format('%<path>s%<id>s/', path: @endpoint, id: id)
+      @session.patch(resource_path, body)
+    end
   end
 
   # An Account is the representation of a bank account inside a financial
@@ -154,7 +171,6 @@ module Belvo
       body = {
         link: link,
         token: options.token,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true
       }.merge(options)
       body = clean body: body
@@ -185,7 +201,6 @@ module Belvo
         date_to: date_to,
         token: options.token,
         account: options.account,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true
       }.merge(options)
       body = clean body: body
@@ -211,7 +226,6 @@ module Belvo
       body = {
         link: link,
         token: options.token,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true
       }.merge(options)
       body = clean body: body
@@ -242,7 +256,6 @@ module Belvo
         date_to: date_to,
         token: options.token,
         account: options.account,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true
       }.merge(options)
       body = clean body: body
@@ -272,7 +285,6 @@ module Belvo
         year: year,
         month: month,
         token: options.token,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true,
         attach_pdf: options.attach_pdf
       }.merge(options)
@@ -297,7 +309,6 @@ module Belvo
       options = IncomeOptions.from(options)
       body = {
         link: link,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true
       }.merge(options)
       body = clean body: body
@@ -328,7 +339,6 @@ module Belvo
         date_to: date_to,
         type: type,
         token: options.token,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true,
         attach_xml: options.attach_xml
       }.merge(options)
@@ -355,7 +365,6 @@ module Belvo
       body = {
         link: link,
         token: options.token,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true,
         attach_pdf: options.attach_pdf
       }.merge(options)
@@ -377,6 +386,11 @@ module Belvo
       @endpoint = 'tax-returns/'
     end
 
+    class TaxReturnType
+      YEARLY = 'yearly'
+      MONTHLY = 'monthly'
+    end
+
     # Retrieve tax returns information from a specific fiscal link.
     # @param link [String] Link UUID
     # @param year_from [Integer]
@@ -384,17 +398,22 @@ module Belvo
     # @param options [TaxReturnOptions] Configurable properties
     # @return [Hash] created tax returns details
     # @raise [RequestError] If response code is different than 2XX
-    def retrieve(link:, year_from:, year_to:, options: nil)
+    def retrieve(link:, year_from: nil, year_to: nil, options: nil)
       options = TaxReturnOptions.from(options)
       body = {
         link: link,
-        year_from: year_from,
-        year_to: year_to,
         token: options.token,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true,
-        attach_pdf: options.attach_pdf
+        attach_pdf: options.attach_pdf,
+        type: options.type
       }.merge(options)
+      if options.type == TaxReturnType::MONTHLY
+        body[:date_from] = options.date_from
+        body[:date_to] = options.date_to
+      else
+        body[:year_from] = year_from
+        body[:year_to] = year_to
+      end
       body = clean body: body
       @session.post(@endpoint, body)
     end
@@ -422,7 +441,6 @@ module Belvo
       body = {
         link: link,
         token: options.token,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true,
         attach_pdf: options.attach_pdf
       }.merge(options)
@@ -456,12 +474,15 @@ module Belvo
     def create(options: nil)
       options = WidgetTokenOptions.from(options)
       link_id = options.link
+      widget = options.widget
       options.delete('link')
+      options.delete('widget')
       body = {
         id: @session.key_id,
         password: @session.key_password,
         scopes: 'read_institutions,write_links,read_links',
-        link_id: link_id
+        link_id: link_id,
+        widget: widget
       }.merge(options)
       body = clean body: body
       @session.post(@endpoint, body)

data/lib/belvo/utils.rb

@@ -11,3 +11,19 @@ class Utils
     Base64.encode64(data)
   end
 end
+
+# Class to get the api url given an environment name
+class Environment
+  SANDBOX = 'https://sandbox.belvo.com'
+  DEVELOPMENT = 'https://development.belvo.com'
+  PRODUCTION = 'https://api.belvo.com'
+
+  def self.get_url(environment)
+    nil unless environment
+    begin
+      const_get environment.upcase
+    rescue NameError
+      environment
+    end
+  end
+end

data/lib/belvo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -149,11 +149,13 @@ files:
 - ".codeclimate.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
+- ".github/workflows/danger-pr-reviews.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dangerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE