belvo 0.12.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3ccb9e6a9841f2313f4a3307a67c3a0527fad92b91f3a84a607150b2bd86dd8
-  data.tar.gz: 1103d2e823428b7a1db97821714bd60764cd0c649d59c1876b309cf2f20e0b8d
+  metadata.gz: 6b7f8335b754a94a4223c81da12e6968e3dfe266a39e3b20e10f2d20a129a3dc
+  data.tar.gz: 1ac5dc601938bd343f480c391f3951b6e1e8cc2261397c38c540094b6bd78428
 SHA512:
-  metadata.gz: f95143ddfe260d93a6462c70e224df80dd43d2c0a76db8c38b8176d0471643fd22de8db22e2f7299d527dd4c7f56842b3c19045a5d2482c9dfc0a0cdaa4b6566
-  data.tar.gz: 85ac380d5e207a78915c4a84c21d2efaf03c76f525e49080a5ef9192931b39b1e983df207e8e614cbdc5c4dcf7c0ca2c69cd64cb403839cb5f1c459b572db658
+  metadata.gz: 683c82016ad8b0c264d3c76b9559a432986a639645416f6ee82ff7925810c0a004325ddc880841ff6a4f140a268e6b01863a1a395bf1d790f34b43391871e89d
+  data.tar.gz: a4072bb4ffe6d220deefddcebdef857e0e9c9d06cdd0f6255520b5bbea72223e9a4451c0f93c5dbfc4485c9e2f9dbc43723d5916cd304fd63e02e97225310dd8

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: 10
+
+      # 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.12.0)
+    belvo (0.15.0)
       faraday
       faraday_middleware
       typhoeus
@@ -9,9 +9,17 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.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,19 +47,34 @@ 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)
+    rchardet (1.8.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 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/README.md

@@ -33,31 +33,60 @@ Or install it yourself as:
 
     $ gem install belvo
 
-## Usage
+## Usage (create link via widget)
+
+When your user successfully links their account using the [Connect Widget](https://developers.belvo.com/docs/connect-widget), your implemented callback funciton will return the `link_id` required to make further API to retrieve information.
+
 
 ```ruby
 require 'belvo'
 
 belvo = Belvo::Client.new(
-  'af6e69ff-43fa-4e10-8d90-3d217309a1e5',
-  'gdi64m68Lc6xUjIKN3aJF2fZd51wD36lTjGVyJO5xQBfL7PRsgFef-ADXBxIhUnd',
-  'https://sandbox.belvo.com'
+  'your-secret-id',
+  'your-secret-password',
+  'sandbox'
 )
 
 begin
-  new_link = belvo.links.register(
-    institution: 'banamex_mx_retail', 
-    username: 'janedoe', 
-    password: 'super-secret',
-    options: { access_mode: Belvo::Link::AccessMode::SINGLE }
-  )
+    # Get the link_id from the result of your widget callback function
+    link_id = result_from_callback_function.id 
+    
+    belvo.accounts.retrieve(link: link_id)
+
+    puts belvo.accounts.list
+rescue Belvo::RequestError => e
+    puts e.status_code
+    puts e.detail
+end
+```
+
+## Usage (create link via SDK)
 
-  belvo.accounts.retrieve(link: new_link['id'])
+You can also manually create the link using the SDK. However, for security purposes, we highly recommend, that you use the [Connect Widget](https://developers.belvo.com/docs/connect-widget) to create the link and follow the **Usage (create link via widget)** example.
 
-  puts belvo.accounts.list
+```ruby
+require 'belvo'
+
+belvo = Belvo::Client.new(
+  'your-secret-id',
+  'your-secret-password',
+  'sandbox'
+)
+
+begin
+    new_link = belvo.links.register( # Creating the link
+        institution: 'banamex_mx_retail', 
+        username: 'janedoe', 
+        password: 'super-secret',
+        options: { access_mode: Belvo::Link::AccessMode::SINGLE }
+        )
+    
+    belvo.accounts.retrieve(link: new_link['id'])
+
+    puts belvo.accounts.list
 rescue Belvo::RequestError => e
-  puts e.status_code
-  puts e.detail
+    puts e.status_code
+    puts e.detail
 end
 ```
 

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/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,7 +17,6 @@ module Belvo
     :username2,
     :username3,
     :password2,
-    :encryption_key,
     :username_type,
     :certificate,
     :private_key,
@@ -30,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
 
@@ -44,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
@@ -58,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
@@ -68,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
@@ -82,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
   )
@@ -96,10 +85,12 @@ 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
+  # @!attribute date_from [rw] Date string (YYYY-MM-DD)
+  # @!attribute date_to [rw] Date string (YYYY-MM-DD)
   class IncomeOptions < Faraday::Options.new(
-    :encryption_key,
-    :save_data
+    :save_data,
+    :date_from,
+    :date_to
   )
   end
 
@@ -107,13 +98,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
@@ -122,12 +111,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
   )
@@ -137,14 +124,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
 
@@ -152,12 +140,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
   )

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,8 +309,9 @@ module Belvo
       options = IncomeOptions.from(options)
       body = {
         link: link,
-        encryption_key: options.encryption_key,
-        save_data: options.save_data || true
+        save_data: options.save_data || true,
+        date_from: options.date_from,
+        date_to: options.date_to
       }.merge(options)
       body = clean body: body
       @session.post(@endpoint, body)
@@ -328,7 +341,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 +367,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 +388,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 +400,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 +443,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)

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.12.0'
+  VERSION = '0.15.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-08-13 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