belvo 0.13.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f69b2401f03d00f211b1029e686b5ecb35b717bdff42dcbac781e207b2feb87
-  data.tar.gz: f93e791acf610e5b1d3f9e3df2fd4cc161003b03d9a303ee66b5ada7c6857b5e
+  metadata.gz: '08f8c79b4030cd51cf761a4e158721f669b2f5cd2003d8675156f5b956f6445b'
+  data.tar.gz: dc16cd3cb2ae3a9c248cd596940a3c2ed6a6c1cfc992ded399afdda299b74d76
 SHA512:
-  metadata.gz: 5e2ba29bf5d230d3f250b9dd3c284f09a01fe0dad4d05b29f6e360392258d5d6e5e93c056863345e6aeb22665fb934368e8b6ca5eac76c4e4089b8eda178d637
-  data.tar.gz: b124c2ce6c01aed682954cc6ee9f08c6f3507c6bee994249466c9f013992b5830e7649aee52032a56f7b20e12722229c7ccf84c9c7cb26db23e742e26051c7e0
+  metadata.gz: 53899dee07e04a593907700009de516caafa3cd1d7a98ead7f9156382841e6569e0a1ec05ef0850bdf380f65eedf51c96c4d31b8275ec31ec1d994cde1bd1c67
+  data.tar.gz: 226b8b4aec7e9ae60cda79a153f70afb6252d0cec45be354e6dbfc539175e8b945be1ccc715ccef137510164cab52edb017d6f4b91113fa22e6ab70c1bb31903

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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (0.13.0)
+    belvo (0.16.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)
@@ -142,4 +142,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

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: '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
 ```
 

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,27 +98,31 @@ 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
 
+  # @!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 TaxComplianceStatusOptions < Faraday::Options
   # 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,15 +132,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,
-    :type
+    :type,
+    :date_from,
+    :date_to
   )
   end
 
@@ -153,12 +148,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
@@ -172,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
@@ -203,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
@@ -229,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
@@ -260,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
@@ -290,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)
@@ -315,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)
@@ -346,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,6 +349,30 @@ 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 incomes 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
+
   # 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
@@ -373,7 +391,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)
@@ -402,8 +419,8 @@ module Belvo
 
     # Retrieve tax returns information from a specific fiscal link.
     # @param link [String] Link UUID
-    # @param year_from [Integer] | [Date]
-    # @param year_to [Integer] | [Date]
+    # @param year_from [Integer]
+    # @param year_to [Integer]
     # @param options [TaxReturnOptions] Configurable properties
     # @return [Hash] created tax returns details
     # @raise [RequestError] If response code is different than 2XX
@@ -412,14 +429,13 @@ module Belvo
       body = {
         link: link,
         token: options.token,
-        encryption_key: options.encryption_key,
         save_data: options.save_data || true,
         attach_pdf: options.attach_pdf,
         type: options.type
       }.merge(options)
       if options.type == TaxReturnType::MONTHLY
-        body[:date_from] = year_from
-        body[:date_to] = year_to
+        body[:date_from] = options.date_from
+        body[:date_to] = options.date_to
       else
         body[:year_from] = year_from
         body[:year_to] = year_to
@@ -451,7 +467,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.13.0'
+  VERSION = '0.16.0'
 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)
 
@@ -75,6 +80,12 @@ 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 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.13.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday