belvo 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd5733a59d486efcc6a6d9e62331a2d6734304bc231e76a19f27a285f7b4c47f
-  data.tar.gz: 408ae0cb0d7a27e8b4f8f4f8a9b7a7a6b3a6d08539d5f938e328af137f26bcb4
+  metadata.gz: 8eec099b22dbcb9dbac55982ac84c447bdae2f69c5f06bb310ea8a1be8889b1d
+  data.tar.gz: dfe77adac6722c395f8b31c867a2a803dabd226fcbda6452ffb29dbe6310e412
 SHA512:
-  metadata.gz: 84f3d999c67f38697b1c18973a70503787a2a4009d41b4bb7d9525bfbc8844451cdfb7f9b1bb71b150df5e1cf76f6164c527d92c4129d49696a80f5526662fbf
-  data.tar.gz: ff94f967de7f91895bc8323f0c6265d405991f4ce547582b920ec657b4c76926225adb6ddade63c72fe3b0e4f1c2e80ea6a7d12764c4ac9d7c3d83c93c6583dc
+  metadata.gz: 71f7405acc9de362147b1182644c0af7bfe358160d070eaaae59b41d95caec18800d9bb589e61ef7dd0ae6ef2c22418cda0dfcd636d1f5165ae430d01b5dd0be
+  data.tar.gz: 90c3ce711c21df50880301629d3555f8dff981441e1dc30e1065e5182550dfd1e1bf43e282d47e58da05cd8131669eb00974f48aa7879ca22c06cf11b94d46a7

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.5.0)
+    belvo (0.7.0)
       faraday
       faraday_middleware
       typhoeus
@@ -11,48 +11,48 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
+    ast (2.4.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)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
     docile (1.3.2)
     ethon (0.12.0)
       ffi (>= 1.3.0)
-    faraday (1.0.1)
+    faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
-    ffi (1.12.2)
+    ffi (1.13.1)
     hashdiff (1.0.1)
     jaro_winkler (1.5.4)
-    json (2.3.0)
+    json (2.3.1)
     multipart-post (2.1.1)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
-    public_suffix (4.0.5)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (12.3.3)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
     rubocop (0.81.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -61,10 +61,10 @@ GEM
       rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-rspec (1.39.0)
+    rubocop-rspec (1.41.0)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
+    ruby2_keywords (0.0.2)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -74,12 +74,12 @@ GEM
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (1.0.1)
-    tins (1.24.1)
+    tins (1.26.0)
       sync
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     unicode-display_width (1.7.0)
-    webmock (3.8.3)
+    webmock (3.9.5)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/README.md

@@ -5,8 +5,17 @@
     <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>
-<p align="center"><a href="https://developers.belvo.co">Developers portal</a> | <a href="https://belvo-finance.github.io/belvo-ruby">Documentation</a></p>
 
+## 📕 Documentation
+How to use `belvo-ruby`: https://belvo-finance.github.io/belvo-ruby/
+
+If you want to check the full documentation about Belvo API: https://docs.belvo.co
+
+Or if you want to more information about:
+* [Getting Belvo API keys](https://developers.belvo.com/docs/get-your-belvo-api-keys)
+* [Using Connect Widget](https://developers.belvo.com/docs/connect-widget)
+* [Testing in sandbox](https://developers.belvo.com/docs/test-in-sandbox)
+* [Using webhooks and recurrent links](https://developers.belvo.com/docs/webhooks)
 
 ## Installation
 
@@ -39,7 +48,8 @@ begin
   new_link = belvo.links.register(
     institution: 'banamex_mx_retail', 
     username: 'janedoe', 
-    password: 'super-secret'
+    password: 'super-secret',
+    options: { access_mode: Belvo::Link::AccessMode::SINGLE }
   )
 
   belvo.accounts.retrieve(link: new_link['id'])

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,11 +7,17 @@ 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 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,
     :token,
+    :username2,
+    :username3,
+    :password2,
     :encryption_key,
     :username_type,
     :certificate,
@@ -86,6 +92,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

@@ -77,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
@@ -85,7 +84,6 @@ module Belvo
       institution:,
       username:,
       password:,
-      password2: nil,
       options: nil
     )
       options = LinkOptions.from(options)
@@ -95,13 +93,7 @@ module Belvo
         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,
-        certificate: options.certificate,
-        private_key: options.private_key
+        access_mode: options.access_mode
       }.merge(options)
       body = clean body: body
       @session.post(@endpoint, body)
@@ -130,6 +122,18 @@ module Belvo
       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
@@ -277,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
@@ -383,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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-11-25 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: []
@@ -191,8 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: The Ruby gem for the Belvo API