belvo 0.4.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff048795b869d8968a35be333ebbd05e4455b11324c0112e936bb864c2ed6b54
-  data.tar.gz: 5cbe5998bc9c47cd37918a1f7d511608316076ac95fa8b5219c6f5a5fa6e56fe
+  metadata.gz: f7e008d86a0b4f4ff368e9027711fc3b32a81886e8a5f392d5c67f84bb417c89
+  data.tar.gz: 7aa7a82b3ee88a0b0cb6f837edaab45996fc8f6eed41024996711cdebd3f9905
 SHA512:
-  metadata.gz: 7823be7ba6522dd1e137d0cb74afe0e732384f18bbc887e617320693de58511c51fdad8db8c4582d013c897a38505662a938f4412e92acc068c0804b9bcc3237
-  data.tar.gz: a3ff06d08002a13e6ea8107d1c5d8e89c3ef3ae881b601b8dd1b0c5e95d8c986e51140d53400537d75bbe347d376f30a270955bc59ad53a9a4615616527d210c
+  metadata.gz: a03bc5b178bf8065bdbd8a04eaf94ba627abbabe212c272ec64d782ba4edf804a22eae7e5c75275857501e22d23708eab6efe3521dc0d589a862ce01c61ee7a8
+  data.tar.gz: 28f60a6dc881c85b213a64c6881eca73fac7f18659a534e16a3bc6eff5c4013c09db9d635a79c2f3c59af90c5214311559335d989f37f35e401db0273610e29f

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.4.0)
+    belvo (0.6.2)
       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
@@ -86,5 +92,11 @@ module Belvo
     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)
@@ -117,6 +120,19 @@ module Belvo
       response.body
     end
 
+    # Perform a POST request to an API endpoint
+    # @param path [String] API endpoint
+    # @param id [String] Resource UUID
+    # @param data [object] JSON parseable object
+    # @return [Hash] Response details
+    # @raise [RequestError] If response code is different than 2XX
+    def token(path, id, data)
+      resource_path = format('%<path>s%<id>s/token/', path: path, id: id)
+      response = @session.post(resource_path, data.to_json)
+      raise_for_status response
+      response.body
+    end
+
     # Perform a POST request to an API endpoint
     # @param path [String] API endpoint
     # @param data [object] JSON parseable object

data/lib/belvo/options.rb

@@ -7,13 +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,
+    :username2,
+    :password2,
     :encryption_key,
-    :username_type
+    :username_type,
+    :certificate,
+    :private_key
   )
   end
 
@@ -84,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.

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,19 +84,16 @@ 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,
-        username_type: options.username_type
+        access_mode: options.access_mode || AccessMode::SINGLE
       }.merge(options)
       body = clean body: body
       @session.post(@endpoint, body)
@@ -109,17 +106,34 @@ 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)
     end
+
+    # Allows to create a token with client-specified scope and short TTL.
+    # @param id [String] Link UUID
+    # @param scopes [String] Configurable scopes eg: "read_links,write_links"
+    # @return [Hash] with a "refresh" and "access" token
+    # @raise [RequestError] If response code is different than 2XX
+    def token(id:, scopes:)
+      body = {
+        scopes: scopes
+      }
+      @session.token(@endpoint, id, body)
+    end
   end
 
   # An Account is the representation of a bank account inside a financial
@@ -267,6 +281,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
@@ -373,4 +411,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.4.0'
+  VERSION = '0.6.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Belvo Finance S.L.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-10-08 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:
@@ -175,7 +176,7 @@ metadata:
   homepage_uri: https://github.com/belvo-finance/belvo-ruby
   source_code_uri: https://github.com/belvo-finance/belvo-ruby
   changelog_uri: https://github.com/belvo-finance/belvo-ruby/blob/master/README.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,9 +191,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: The Ruby gem for the Belvo API
 test_files: []