belvo 0.14.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '038fbaeb161f1c341855ded020989160dc8ebbbcea33f5fe05fa0c92c81d0bcf'
-  data.tar.gz: 4eee5f78d13eb4fff6a3a01ed50aa673a4b62b0bb10b45b86795d8e980f1a48d
+  metadata.gz: fbba449f201c38edea545d7fe6872cc9a8c9889e4f80d8d8a40b7b61818cbe63
+  data.tar.gz: 5cf8afcb0d4399501fd3164574bc11b809d0b13fb424c903853c5de48af286f8
 SHA512:
-  metadata.gz: 4845b72c9a053c7bc8fabe97d6990cd1006fc75b4493f42944aac21cc3aea72860a2d9d7ab0cc0ae56f1a68f465c9c0aff1c9ca76c39e3ee82a4f638862f955b
-  data.tar.gz: d41485f0c38659baa74b675d9220f3f1a07086d62c0ead42c886e3dedd06d0c4bcaab7ee878cc5cbe1dcf06e01eb7cd0d71413925be407c26af1617b596e1e1f
+  metadata.gz: ee61c813d1e3ee24c121cbfa153177cd74b651a6f5166c34d233823d2dba0de28a823d572dc25f0be326b488dd5b69a522c203ed3a6fe2175a3ed0731b03dfc7
+  data.tar.gz: f13e6b50640906ba4bb72be13f5157eae26be7b5bb23c480ada64574e4e032d762832702bc2fc3f510374cc973995ecfcd90ed097dae6651c77b460d1d168fc8

data/.circleci/config.yml

@@ -0,0 +1,54 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@1.0.4
+jobs:
+  test:
+    docker:
+      - image: cimg/ruby:2.7
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Install deps
+          command: gem install bundler -v 2.1.4
+      - run:
+          name: Run tests
+          command: |
+            bundle exec rubocop
+            bundle exec rspec spec
+  deploy-to-rubygems:
+    docker:
+      - image: cimg/ruby:2.7
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Set Rubygems credentials
+          command: |
+            mkdir ~/.gem
+            echo -e "---\r\n:rubygems_api_key: $GEM_HOST_API_KEY" > ~/.gem/credentials
+            chmod 0600 /home/circleci/.gem/credentials
+      - run:
+          name: Publish gem to Rubygems
+          command: bundle exec rake release
+
+workflows:
+  build-test-deploy:
+    jobs:
+      - test:
+          filters:
+            tags:
+              only: /v.*/
+          context:
+            - shared
+      - deploy-to-rubygems:
+          requires:
+            - test
+          filters:
+            branches:
+              only:
+                - master
+            tags:
+              only: /^v.*/
+          context:
+            - shared

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

@@ -11,7 +11,7 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v2
         with:
-          fetch-depth: 1
+          fetch-depth: 10
 
       # Setup ruby
       - name: Set up Ruby 2.6

data/Gemfile

@@ -6,7 +6,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in belvo.gemspec
 gemspec
 
-gem 'coveralls', require: false
+gem 'coveralls_reborn', require: false
 gem 'faraday'
 gem 'faraday_middleware'
 gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (0.14.0)
+    belvo (0.18.0)
       faraday
       faraday_middleware
       typhoeus
@@ -9,7 +9,7 @@ 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)
@@ -20,12 +20,11 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    coveralls (0.8.23)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.16.1)
-      term-ansicolor (~> 1.3)
-      thor (>= 0.19.4, < 2.0)
-      tins (~> 1.6)
+    coveralls_reborn (0.23.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)
     danger (8.2.1)
       claide (~> 1.0)
@@ -41,7 +40,7 @@ GEM
       octokit (~> 4.7)
       terminal-table (~> 1)
     diff-lcs (1.4.4)
-    docile (1.3.2)
+    docile (1.4.0)
     ethon (0.12.0)
       ffi (>= 1.3.0)
     faraday (1.1.0)
@@ -56,7 +55,6 @@ GEM
       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)
@@ -104,18 +102,19 @@ GEM
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
-    simplecov (0.16.1)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     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)
+    thor (1.1.0)
+    tins (1.29.1)
       sync
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
@@ -130,7 +129,7 @@ PLATFORMS
 
 DEPENDENCIES
   belvo!
-  coveralls
+  coveralls_reborn
   danger (= 8.2.1)
   faraday
   faraday_middleware
@@ -142,4 +141,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -1,7 +1,7 @@
 <h1 align="center">Belvo Ruby Gem</h1>
 <p align="center">
     <a href="https://rubygems.org/gems/belvo"><img alt="Rubygems.org" src="https://img.shields.io/gem/v/belvo?style=for-the-badge"></a>
-    <a href="https://travis-ci.com/belvo-finance/belvo-ruby"><img alt="Travis (.com)" src="https://img.shields.io/travis/com/belvo-finance/belvo-ruby/master?style=for-the-badge"></a>
+    <a href="https://app.circleci.com/pipelines/github/belvo-finance/belvo-ruby"><img alt="CircleCI (.com)" src="https://img.shields.io/travis/com/belvo-finance/belvo-ruby/master?style=for-the-badge"></a>
     <a href="https://coveralls.io/github/belvo-finance/belvo-ruby"><img alt="Coveralls github" src="https://img.shields.io/coveralls/github/belvo-finance/belvo-ruby?style=for-the-badge"></a>
     <a href="https://codeclimate.com/github/belvo-finance/belvo-ruby"><img alt="CodeClimate maintainability" src="https://img.shields.io/codeclimate/maintainability/belvo-finance/belvo-ruby?style=for-the-badge"></a>
 </p>
@@ -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
+```
 
-  belvo.accounts.retrieve(link: new_link['id'])
+## Usage (create link via SDK)
 
-  puts belvo.accounts.list
+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.
+
+```ruby
+require 'belvo'
+
+belvo = Belvo::Client.new(
+  'your-secret-id',
+  'your-secret-password',
+  'sandbox'
+)
+
+begin
+    new_link = belvo.links.register( # Creating the link
+        institution: 'erebor_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
 ```
 
@@ -67,7 +96,14 @@ end
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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
+- Create a new pull request for the new version.
+- Once the new version is merged in `master`, create a `tag` matching the new version.
 
 ## Contributing
 

data/belvo.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday_middleware'
   spec.add_dependency 'typhoeus'
 
-  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'coveralls_reborn'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.81.0'

data/lib/belvo/options.rb

@@ -85,8 +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 date_from [rw] Date string (YYYY-MM-DD)
+  # @!attribute date_to [rw] Date string (YYYY-MM-DD)
   class IncomeOptions < Faraday::Options.new(
-    :save_data
+    :save_data,
+    :date_from,
+    :date_to
   )
   end
 
@@ -103,6 +107,22 @@ module Belvo
   )
   end
 
+  # @!class RecurringExpensesOptions < Faraday::Options
+  # Contains configurable properties of a Recurring Expense
+  # @!attribute save_data [rw] Should data be persisted or not.
+  class RecurringExpensesOptions < Faraday::Options.new(
+    :save_data
+  )
+  end
+
+  # @!class RiskInsights < Faraday::Options
+  # Contains configurable properties of a RiskInsights object
+  # @!attribute save_data [rw] Should data be persisted or not.
+  class RiskInsightsOptions < Faraday::Options.new(
+    :save_data
+  )
+  end
+
   # @!class TaxComplianceStatusOptions < Faraday::Options
   # Contains configurable properties of a TaxComplianceStatus
   # @!attribute save_data [rw] Should data be persisted or not.

data/lib/belvo/resources.rb

@@ -309,7 +309,9 @@ module Belvo
       options = IncomeOptions.from(options)
       body = {
         link: link,
-        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)
@@ -347,6 +349,54 @@ module Belvo
     end
   end
 
+  # Recurring Expenses contain a resume of one year
+  # of Transactions inside an Account.
+  class RecurringExpenses < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'recurring-expenses/'
+    end
+
+    # Retrieve recurring expenses information from a specific banking link
+    # @param link [String] Link UUID
+    # @param options [RecurringExpensesOptions] Configurable properties
+    # @return [Hash] created RecurringExpenses details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = RecurringExpensesOptions.from(options)
+      body = {
+        link: link,
+        save_data: options.save_data || true
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+  end
+
+  # RiskInsights contain relevant metrics about
+  # the credit risk of a Link
+  class RiskInsights < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'risk-insights/'
+    end
+
+    # Retrieve risk insights information from a specific banking link
+    # @param link [String] Link UUID
+    # @param options [RiskInsightsOptions] Configurable properties
+    # @return [Hash] created RiskInsights details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = RiskInsightsOptions.from(options)
+      body = {
+        link: link,
+        save_data: options.save_data || true
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+  end
+
   # A Tax compliance status is the representation of the tax situation
   # of a person or a business to the tax authority in the country.
   class TaxComplianceStatus < Resource

data/lib/belvo/version.rb

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

data/lib/belvo.rb

@@ -80,6 +80,18 @@ module Belvo
       @invoices = Invoice.new @session
     end
 
+    # Provides access to RecurringExpenses resource
+    # @return [RecurringExpense]
+    def recurring_expenses
+      @recurring_expenses = RecurringExpenses.new @session
+    end
+
+    # Provides access to RiskInsights resource
+    # @return [RiskInsights]
+    def risk_insights
+      @risk_insights = RiskInsights.new @session
+    end
+
     # Provides access to TaxComplianceStatus resource
     # @return [TaxComplianceStatus]
     def tax_compliance_status

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,6 +146,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".codeclimate.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
@@ -153,7 +154,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Dangerfile
 - Gemfile
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: The Ruby gem for the Belvo API

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.5
-before_install: gem install bundler -v 2.1.4
-script:
-  - bundle exec rubocop
-  - bundle exec rspec spec
-deploy:
-  provider: rubygems
-  api_key:
-    secure: nsKurIEds1W6zwyj0mDmYx77amlDJOycegZV9o+OrBOzRRcpT+O3oFHGouMzAQyIbdUtmWyXp9uJHBEz7Q6Zc5fy6iG05sGO7tFoJMlKiPE5piiOTM5y6qt1GjZ1MYIU0rpnsp9QDsVUR1ATGpoD9O/zzn/lOPbxp2FoWHqWra84D/1jvVXPTqslLgup+GDsxseiAfwTMoTy65TXodISkvoYtlPL3EBV4/XQVBjVGGtM5mdjDJg+YA4yVA2NwCCjhFcj88fRxBmqWRnG/pzmX3nyRlMGjtUBm8OpLSR1NiXXqgzYUAVMD8/8VL/h3OsBqvwqgjZKMO6rXqNKFJQAxYUqvJaLcHP8D05dxWlumqwxlHzscKWLjAe7JbVo2DiAMvMTR8NTJOI7LOraU10iFHtmwAVnyBOaSJUVJuFgAoybq9tqYoZ/uZ7shCuWVNUIWIQM7HN9v99tfvemXMB+2RIN565bzBWSorn5MvXsApvqCLLDFuRnt7urR+0ZyT4dKXgvWRhnNOQgiMwEE/8+Y66nKVB7iNxFDw6LtittyoOZ0HvbHQDtqXOkzT/yaq2Ff2zwuUNYrCHqcdnxg5TBOYg5ndurcFxAc77ZlNSvidEC9tgXHA1m+r0Vq+ZCWOiyyohX33ZfA/UsAIStKr7a6ZLZZywuiqXasg1O9XoRB74=
-  gem: belvo
-  on:
-    tags: true
-    repo: belvo-finance/belvo-ruby
-    branch: master  
-  skip_cleanup: 'true'