belvo 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbba449f201c38edea545d7fe6872cc9a8c9889e4f80d8d8a40b7b61818cbe63
-  data.tar.gz: 5cf8afcb0d4399501fd3164574bc11b809d0b13fb424c903853c5de48af286f8
+  metadata.gz: 05a03ab57113f17e822b4f48dd813edf5206bacfb79a757332fce693a60db786
+  data.tar.gz: 2676ef16eabab4fcbd553ec28cf7378539eb468387954a2754b62d1c6642fe6e
 SHA512:
-  metadata.gz: ee61c813d1e3ee24c121cbfa153177cd74b651a6f5166c34d233823d2dba0de28a823d572dc25f0be326b488dd5b69a522c203ed3a6fe2175a3ed0731b03dfc7
-  data.tar.gz: f13e6b50640906ba4bb72be13f5157eae26be7b5bb23c480ada64574e4e032d762832702bc2fc3f510374cc973995ecfcd90ed097dae6651c77b460d1d168fc8
+  metadata.gz: 522bc53deacef6bc63010a44d837acc100560bd9cb5a3721eea94cde3b37abb3090c385c9c0c2d411ebfd39fe9c1c88fc905ba03dc6bf70cb2ed58899af0f1c8
+  data.tar.gz: 4bcee96d178f49fc23bac577725560f279f21e8a96670694b5d0f2918871e0ea5e332ba09b421769e24740217402e45c55f6e2bdfaaeda0c04caba00d0d92411

data/.circleci/config.yml

@@ -46,8 +46,7 @@ workflows:
             - test
           filters:
             branches:
-              only:
-                - master
+              ignore: /.*/
             tags:
               only: /^v.*/
           context:

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @belvo-finance/ruby @belvo-finance/opensource

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

@@ -0,0 +1,26 @@
+name: Build & deploy Ruby SDK documentation
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Update gh-pages with docs
+    steps:
+      - name: Checkout Belvo Ruby SDK repo
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: "2.7"
+      - name: Install required gem dependencies
+        run: gem install yard --no-document
+      - name: Build RUBY SDK docs with YARD
+        run: yardoc --output-dir docs
+      - name: Deploy docs to gh-pages branch
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+          publish_branch: gh-pages

data/.rubocop.yml

@@ -25,3 +25,6 @@ Style/HashTransformKeys:
 
 Style/HashTransformValues:
   Enabled: true
+
+RSpec/MultipleExpectations:
+  Max: 2

data/Gemfile

@@ -1,4 +1,3 @@
-# rubocop:disable all
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
@@ -6,14 +5,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in belvo.gemspec
 gemspec
 
-gem 'coveralls_reborn', require: false
-gem 'faraday'
-gem 'faraday_middleware'
-gem 'rake', '~> 12.0'
-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.18.0)
+    belvo (0.20.0)
       faraday
       faraday_middleware
       typhoeus
@@ -11,8 +11,8 @@ GEM
   specs:
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
-    claide (1.0.3)
+    ast (2.4.2)
+    claide (1.1.0)
     claide-plugins (0.9.2)
       cork
       nap
@@ -20,12 +20,13 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    coveralls_reborn (0.23.0)
+    coveralls_reborn (0.24.0)
       simplecov (>= 0.18.1, < 0.22.0)
       term-ansicolor (~> 1.6)
       thor (>= 0.20.3, < 2.0)
       tins (~> 1.16)
-    crack (0.4.4)
+    crack (0.4.5)
+      rexml
     danger (8.2.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
@@ -39,54 +40,74 @@ GEM
       no_proxy_fix
       octokit (~> 4.7)
       terminal-table (~> 1)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     docile (1.4.0)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    faraday (1.1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
     faraday-http-cache (2.2.0)
       faraday (>= 0.8)
-    faraday_middleware (1.0.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
-    ffi (1.13.1)
-    git (1.8.1)
+    ffi (1.15.5)
+    git (1.11.0)
       rchardet (~> 1.8)
     hashdiff (1.0.1)
     jaro_winkler (1.5.4)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       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)
+    octokit (4.22.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.20.0)
-    parser (2.7.2.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
     rake (12.3.3)
     rchardet (1.8.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rubocop (0.81.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -97,8 +118,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-rspec (1.41.0)
       rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -107,20 +128,20 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+    simplecov_json_formatter (0.1.4)
     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.1.0)
-    tins (1.29.1)
+    thor (1.2.1)
+    tins (1.31.0)
       sync
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    unicode-display_width (1.7.0)
-    webmock (3.9.5)
-      addressable (>= 2.3.6)
+    unicode-display_width (1.8.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
@@ -131,13 +152,10 @@ DEPENDENCIES
   belvo!
   coveralls_reborn
   danger (= 8.2.1)
-  faraday
-  faraday_middleware
   rake (~> 12.0)
   rspec (~> 3.0)
   rubocop (~> 0.81.0)
   rubocop-rspec
-  typhoeus
   webmock
 
 BUNDLED WITH

data/lib/belvo/http.rb

@@ -17,7 +17,7 @@ module Belvo
     # @param url [String] Belvo API host url
     # @return [Faraday::Connection]
     def initialize(url)
-      @url = format('%<url>s/api/', url: url)
+      @url = format('%<url>s/', url: url)
       @session = Faraday::Connection.new(url: @url) do |faraday|
         faraday.adapter :typhoeus
         faraday.response :json
@@ -41,7 +41,7 @@ module Belvo
         raise RequestError.new(
           'Request error',
           response.status,
-          response.body.to_s
+          response.body
         )
       end
       response
@@ -51,8 +51,8 @@ module Belvo
     # @return [Boolean] True if credentials are valid to authenticate
     #   to Belvo API else False.
     def authenticate
-      @session.basic_auth(@key_id, @key_password)
-      response = @session.get('')
+      @session.request(:basic_auth, @key_id, @key_password)
+      response = @session.get('api/')
       response.success?
     end
 
@@ -113,7 +113,7 @@ module Belvo
       params = {} if params.nil?
 
       resource_path = format('%<path>s%<id>s/', path: path, id: id)
-      response = get(resource_path, params)
+      response = get(resource_path, **params)
 
       raise_for_status response
       response.body

data/lib/belvo/options.rb

@@ -175,4 +175,23 @@ module Belvo
     :widget
   )
   end
+
+  # @!class InvestmentsPortfolioOptions < Faraday::Options
+  # Contains configurable properties of an InvestmentsPortfolio
+  # @!attribute save_data [rw] Should data be persisted or not.
+  # @!attribute token [rw] OTP token required by the institution
+  class InvestmentsPortfolioOptions < Faraday::Options.new(:token, :save_data)
+  end
+
+  # @!class InvestmentsTransactionOptions < Faraday::Options
+  # Contains configurable properties of an InvestmentsTransaction
+  # @!attribute date_to [rw] Date string (YYYY-MM-DD)
+  # @!attribute save_data [rw] Should data be persisted or not.
+  # @!attribute token [rw] OTP token required by the institution
+  class InvestmentsTransactionOptions < Faraday::Options.new(
+    :date_to,
+    :token,
+    :save_data
+  )
+  end
 end

data/lib/belvo/resources.rb

@@ -25,11 +25,14 @@ module Belvo
 
     # List all results
     # @param params [Hash] Extra parameters sent as query strings.
-    # @return [Array]
+    # @return [Array] List of results when no block is passed.
+    # @yield [Hash] Each result to be processed individually.
     # @raise [RequestError] If response code is different than 2XX
     def list(params: nil)
-      results = []
-      @session.list(@endpoint, params: params) { |item| results.push item }
+      results = block_given? ? nil : []
+      @session.list(@endpoint, params: params) do |item|
+        results.nil? ? yield(item) : results.push(item)
+      end
       results
     end
 
@@ -70,7 +73,7 @@ module Belvo
 
     def initialize(session)
       super(session)
-      @endpoint = 'links/'
+      @endpoint = 'api/links/'
     end
 
     # Register a new link
@@ -158,7 +161,7 @@ module Belvo
   class Account < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'accounts/'
+      @endpoint = 'api/accounts/'
     end
 
     # Retrieve accounts from an existing link
@@ -183,7 +186,7 @@ module Belvo
   class Transaction < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'transactions/'
+      @endpoint = 'api/transactions/'
     end
 
     # Retrieve transactions from an existing link
@@ -213,7 +216,7 @@ module Belvo
   class Owner < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'owners/'
+      @endpoint = 'api/owners/'
     end
 
     # Retrieve owners from an existing link
@@ -237,7 +240,7 @@ module Belvo
   class Balance < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'balances/'
+      @endpoint = 'api/balances/'
     end
 
     # Retrieve balances from a specific account or all accounts from a
@@ -267,7 +270,7 @@ module Belvo
   class Statement < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'statements/'
+      @endpoint = 'api/statements/'
     end
 
     # Retrieve statements information from a specific banking link.
@@ -297,7 +300,7 @@ module Belvo
   class Income < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'incomes/'
+      @endpoint = 'api/incomes/'
     end
 
     # Retrieve incomes information from a specific banking link.
@@ -324,7 +327,7 @@ module Belvo
   class Invoice < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'invoices/'
+      @endpoint = 'api/invoices/'
     end
 
     # @param link [String] Link UUID
@@ -354,7 +357,7 @@ module Belvo
   class RecurringExpenses < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'recurring-expenses/'
+      @endpoint = 'api/recurring-expenses/'
     end
 
     # Retrieve recurring expenses information from a specific banking link
@@ -378,7 +381,7 @@ module Belvo
   class RiskInsights < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'risk-insights/'
+      @endpoint = 'api/risk-insights/'
     end
 
     # Retrieve risk insights information from a specific banking link
@@ -402,7 +405,7 @@ module Belvo
   class TaxComplianceStatus < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'tax-compliance-status/'
+      @endpoint = 'api/tax-compliance-status/'
     end
 
     # Retrieve tax compliance status information from a specific fiscal link.
@@ -433,7 +436,7 @@ module Belvo
   class TaxReturn < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'tax-returns/'
+      @endpoint = 'api/tax-returns/'
     end
 
     class TaxReturnType
@@ -478,7 +481,7 @@ module Belvo
   class TaxStatus < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'tax-status/'
+      @endpoint = 'api/tax-status/'
     end
 
     # Retrieve tax status information from a specific fiscal link.
@@ -508,7 +511,7 @@ module Belvo
   class Institution < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'institutions/'
+      @endpoint = 'api/institutions/'
     end
   end
 
@@ -518,7 +521,7 @@ module Belvo
   class WidgetToken < Resource
     def initialize(session)
       super(session)
-      @endpoint = 'token/'
+      @endpoint = 'api/token/'
     end
 
     def create(options: nil)
@@ -538,4 +541,57 @@ module Belvo
       @session.post(@endpoint, body)
     end
   end
+
+  # A InvestmentsPortfolio is a comprehensive view of your user's current
+  # investment holdings
+  class InvestmentsPortfolio < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'investments/portfolios/'
+    end
+
+    # Retrieve investments portfolios from an existing link
+    # @param link [String] Link UUID
+    # @param options [InvestmentsPortfolioOptions] Configurable properties
+    # @return [Hash] created investments portfolios details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = InvestmentsPortfolioOptions.from(options)
+      body = {
+        link: link,
+        token: options.token,
+        save_data: options.save_data || true
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+  end
+
+  # A InvestmentsTransaction gets the existing transactions for an instrument
+  class InvestmentsTransaction < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'investments/transactions/'
+    end
+
+    # Retrieve investments transactions from an existing link
+    # @param link [String] Link UUID
+    # @param date_from [String] Date string (YYYY-MM-DD)
+    # @param options [InvestmentsTransactionOptions] Configurable properties
+    # @return [Hash] created investments transactions details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, date_from:, options: nil)
+      options = InvestmentsTransactionOptions.from(options)
+      date_to = options.date_to || Date.today.to_s
+      body = {
+        link: link,
+        date_from: date_from,
+        date_to: date_to,
+        token: options.token,
+        save_data: options.save_data || true
+      }.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 = '0.18.0'
+  VERSION = '0.20.0'
 end

data/lib/belvo.rb

@@ -121,5 +121,17 @@ module Belvo
     def widget_token
       @widget_token = WidgetToken.new @session
     end
+
+    # Provides access to InvestmentsPortfolio resource
+    # @return [InvestmentsPortfolio]
+    def investments_portfolio
+      @investments_portfolio = InvestmentsPortfolio.new @session
+    end
+
+    # Provides access to InvestmentsTransaction resource
+    # @return [InvestmentsTransaction]
+    def investments_transaction
+      @investments_transaction = InvestmentsTransaction.new @session
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -148,9 +148,11 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".codeclimate.yml"
+- ".github/CODEOWNERS"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
 - ".github/workflows/danger-pr-reviews.yml"
+- ".github/workflows/generate-docs.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -193,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
 summary: The Ruby gem for the Belvo API