belvo 0.3.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50dc56e84a0e3da9460063b4d5589044ad4d88d29f8182ac21d106953e169d55
-  data.tar.gz: 50d11079afd1b518d03e30b75d5b1dc5a44e725d7c449cf0036ecc36294a404e
+  metadata.gz: 8746f7636ac5bd7c67d0041ec84aa9240d9477687d98f826c28ea22135beb9c7
+  data.tar.gz: 91849cb78edce6d00eb636c29334b6eb4c958cf4e089ce734e5bda2f74fe3f54
 SHA512:
-  metadata.gz: '01414806db87f0512b9c8fe0ff9c611e2e248edb18c24a368173b35b439da0a7fa10b29e25d8e5c86048e4b67936e1d2359b886d94cb2a55ffb558bcc05f1cb0'
-  data.tar.gz: 97053b093f9ac116decbad414b859da65de6b3ee2d18a53dfca5bd896db2a302be3c15f8d3c2823d144d7078ab14f92d09775cc16e1249d24e2113c3cf081c42
+  metadata.gz: 7e9f1c00f82387e356be66ce824cf97b0eb11472e8eb738e5e5db759317e957b9908238187f199b74844587fac9db3f4f4854c7eaf855b58cbf46ee1a395c886
+  data.tar.gz: 4d88c38fca8ca0e206844f7e0bedd33b323e6fba76f14cc30aa1adee405d252978cd373282952dacb581aede77af9b6db8046078e90c054545b6af88e179bbed

data/.travis.yml

@@ -1,4 +1,3 @@
----
 language: ruby
 cache: bundler
 rvm:
@@ -7,3 +6,12 @@ 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
+  skip_cleanup: 'true'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (0.3.1)
+    belvo (0.6.1)
       faraday
       faraday_middleware
       typhoeus
@@ -34,9 +34,9 @@ GEM
     json (2.3.0)
     multipart-post (2.1.1)
     parallel (1.19.1)
-    parser (2.7.1.0)
+    parser (2.7.1.2)
       ast (~> 2.4.0)
-    public_suffix (4.0.4)
+    public_suffix (4.0.5)
     rainbow (3.0.0)
     rake (12.3.3)
     rexml (3.2.4)
@@ -44,15 +44,15 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
     rubocop (0.81.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -61,7 +61,7 @@ GEM
       rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-rspec (1.38.1)
+    rubocop-rspec (1.39.0)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
@@ -74,9 +74,9 @@ GEM
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (1.0.1)
-    tins (1.24.1)
+    tins (1.25.0)
       sync
-    typhoeus (1.3.1)
+    typhoeus (1.4.0)
       ethon (>= 0.9.0)
     unicode-display_width (1.7.0)
     webmock (3.8.3)

data/belvo.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name = 'belvo'
   spec.version = Belvo::VERSION
   spec.authors = ['Belvo Finance S.L.']
-  spec.email = ['hello@belvo.co']
+  spec.email = ['sdks@belvo.co']
   spec.license = 'MIT'
   spec.summary = 'The Ruby gem for the Belvo API'
   spec.description = %(Belvo is the leading Open Banking API platform in Latin

data/lib/belvo.rb

@@ -63,6 +63,12 @@ module Belvo
       @statements = Statement.new @session
     end
 
+    # Provides access to Incomes resource
+    # @return [Income]
+    def incomes
+      @incomes = Income.new @session
+    end
+
     # Provides access to Invoices resource
     # @return [Invoice]
     def invoices
@@ -75,10 +81,22 @@ module Belvo
       @tax_returns = TaxReturn.new @session
     end
 
+    # Provides access to TaxStatus resource
+    # @return [TaxStatus]
+    def tax_status
+      @tax_status = TaxStatus.new @session
+    end
+
     # Provides access to Instituions resource
     # @return [Institution]
     def institutions
       @institutions = Institution.new @session
     end
+
+    # Provides access to WidgetToken resource
+    # @return [WidgetToken]
+    def widget_token
+      @widget_token = WidgetToken.new @session
+    end
   end
 end

data/lib/belvo/http.rb

@@ -11,6 +11,9 @@ require 'belvo/exceptions'
 module Belvo
   # Describes a Belvo API session
   class APISession
+    attr_reader :key_id
+    attr_reader :key_password
+
     # @param url [String] Belvo API host url
     # @return [Faraday::Connection]
     def initialize(url)

data/lib/belvo/options.rb

@@ -7,11 +7,19 @@ module Belvo
   # Contains the configurable properties for a Link
   # @!attribute access_mode [rw] Link access mode (SINGLE or RECURRENT)
   # @!attribute token [rw] OTP token required by the institution
+  # @!attribute username2 [rw] End-user secondary 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,
     :token,
-    :encryption_key
+    :username2,
+    :password2,
+    :encryption_key,
+    :username_type,
+    :certificate,
+    :private_key
   )
   end
 
@@ -82,6 +90,16 @@ module Belvo
   )
   end
 
+  # @!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
+
   # @!class InvoiceOptions < Faraday::Options
   # Contains configurable properties of an Invoice
   # @!attribute save_data [rw] Should data be persisted or not.
@@ -111,4 +129,19 @@ module Belvo
     :attach_pdf
   )
   end
+
+  # @!class TaxStatusOptions < Faraday::Options
+  # 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
+  )
+  end
 end

data/lib/belvo/resources.rb

@@ -2,6 +2,7 @@
 
 require 'date'
 require 'belvo/options'
+require 'belvo/utils'
 
 module Belvo
   # Represents a consumable REST resource from Belvo API
@@ -76,7 +77,6 @@ module Belvo
     # @param institution [String] Institution name
     # @param username [String] End-user username
     # @param password [String] End-user password
-    # @param password2 [String, nil] End-user secondary password, if any
     # @param options [LinkOptions] Configurable properties
     # @return [Hash] created link details
     # @raise [RequestError] If response code is different than 2XX
@@ -84,17 +84,15 @@ module Belvo
       institution:,
       username:,
       password:,
-      password2: nil,
       options: nil
     )
       options = LinkOptions.from(options)
+      options.certificate = Utils.read_file_to_b64(options.certificate)
+      options.private_key = Utils.read_file_to_b64(options.private_key)
       body = {
         institution: institution,
         username: username,
         password: password,
-        password2: password2,
-        token: options.token,
-        encryption_key: options.encryption_key,
         access_mode: options.access_mode || AccessMode::SINGLE
       }.merge(options)
       body = clean body: body
@@ -108,13 +106,18 @@ module Belvo
     # @param options [LinkOptions] Configurable properties
     # @return [Hash] link details
     # @raise [RequestError] If response code is different than 2XX
-    def update(id:, password:, password2: nil, options: nil)
+    def update(id:, password: nil, password2: nil, options: nil)
       options = LinkOptions.from(options)
+      options.certificate = Utils.read_file_to_b64(options.certificate)
+      options.private_key = Utils.read_file_to_b64(options.private_key)
       body = {
         password: password,
         password2: password2,
         token: options.token,
-        encryption_key: options.encryption_key
+        encryption_key: options.encryption_key,
+        username_type: options.username_type,
+        certificate: options.certificate,
+        private_key: options.private_key
       }.merge(options)
       body = clean body: body
       @session.put(@endpoint, id, body)
@@ -132,7 +135,7 @@ module Belvo
     # Retrieve accounts from an existing link
     # @param link [String] Link UUID
     # @param options [AccountOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created accounts details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, options: nil)
       options = AccountOptions.from(options)
@@ -159,7 +162,7 @@ module Belvo
     # @param link [String] Link UUID
     # @param date_from [String] Date string (YYYY-MM-DD)
     # @param options [TransactionOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created transactions details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, date_from:, options: nil)
       options = TransactionOptions.from(options)
@@ -189,7 +192,7 @@ module Belvo
     # Retrieve owners from an existing link
     # @param link [String] Link UUID
     # @param options [OwnerOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created owners details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, options: nil)
       options = OwnerOptions.from(options)
@@ -216,7 +219,7 @@ module Belvo
     # @param link [String] Link UUID
     # @param date_from [String] Date string (YYYY-MM-DD)
     # @param options [BalanceOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created balances details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, date_from:, options: nil)
       options = BalanceOptions.from(options)
@@ -247,7 +250,7 @@ module Belvo
     # @param year [Integer]
     # @param month [Integer]
     # @param options [StatementOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created statement details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, account:, year:, month:, options: nil)
       options = StatementOptions.from(options)
@@ -266,6 +269,30 @@ module Belvo
     end
   end
 
+  # A Income contains a resume of monthly Transactions inside an Account.
+  class Income < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'incomes/'
+    end
+
+    # Retrieve incomes information from a specific banking link.
+    # @param link [String] Link UUID
+    # @param options [IncomesOptions] Configurable properties
+    # @return [Hash] created incomes details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = IncomeOptions.from(options)
+      body = {
+        link: link,
+        encryption_key: options.encryption_key,
+        save_data: options.save_data || true
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+  end
+
   # An Invoice is the representation of an electronic invoice, that can be
   # received or sent, by a business or an individual and has been uploaded
   # to the fiscal institution website
@@ -279,7 +306,7 @@ module Belvo
     # @param date_from [String] Date string (YYYY-MM-DD)
     # @param date_to [String] Date string (YYYY-MM-DD)
     # @param options [InvoiceOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created invoices details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, date_from:, date_to:, type:, options: nil)
       options = InvoiceOptions.from(options)
@@ -311,7 +338,7 @@ module Belvo
     # @param year_from [Integer]
     # @param year_to [Integer]
     # @param options [TaxReturnOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created tax returns details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, year_from:, year_to:, options: nil)
       options = TaxReturnOptions.from(options)
@@ -333,6 +360,37 @@ module Belvo
     end
   end
 
+  # A Tax status is the representation of the tax situation of a person or a
+  # business to the tax authority in the country.
+  class TaxStatus < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'tax-status/'
+    end
+
+    # Retrieve tax status information from a specific fiscal link.
+    # @param link [String] Link UUID
+    # @param options [TaxStatusOptions] Configurable properties
+    # @return [Hash] created tax status details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = TaxStatusOptions.from(options)
+      body = {
+        link: link,
+        token: options.token,
+        encryption_key: options.encryption_key,
+        save_data: options.save_data || true,
+        attach_pdf: options.attach_pdf
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+
+    def resume(_session_id, _token, _link: nil)
+      raise NotImplementedError 'TaxReturn does not support resuming a session.'
+    end
+  end
+
   # An Institution is an entity that Belvo can access information from. It can
   # be a bank or fiscal type of institutions such as the SAT in Mexico.
   class Institution < Resource
@@ -341,4 +399,23 @@ module Belvo
       @endpoint = 'institutions/'
     end
   end
+
+  # A WidgetToken is a limited scope with short time to live token, that
+  # contains access and refresh keys to allow you embedding Belvo's Connect
+  # Widget into your app.
+  class WidgetToken < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'token/'
+    end
+
+    def create
+      body = {
+        id: @session.key_id,
+        password: @session.key_password,
+        scopes: 'read_institutions,write_links,read_links,delete_links'
+      }
+      @session.post(@endpoint, body)
+    end
+  end
 end

data/lib/belvo/utils.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+# Class with helper functions
+class Utils
+  def self.read_file_to_b64(path)
+    return if path.nil? || !File.file?(path)
+
+    data = File.open(path).read
+    Base64.encode64(data)
+  end
+end

data/lib/belvo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -141,7 +141,7 @@ description: |-
                          America and the easiest way for users to connect their
                          account to an app
 email:
-- hello@belvo.co
+- sdks@belvo.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -167,6 +167,7 @@ files:
 - lib/belvo/http.rb
 - lib/belvo/options.rb
 - lib/belvo/resources.rb
+- lib/belvo/utils.rb
 - lib/belvo/version.rb
 homepage: https://github.com/belvo-finance/belvo-ruby
 licenses:
@@ -190,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: The Ruby gem for the Belvo API