belvo 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c1dcb245d74ddc040cd5e0f820ff9ecefa761e0135ee16fe5b08a6bf89dae26
-  data.tar.gz: d2a243cd3f86fd7bb295a8fd85dab1e7226aa95f60ee5d8c30a5b3905dcd9918
+  metadata.gz: 53c6172de053ccd0f9028de57bcbf117bf70203d145d43683aa2bb9ea655ff07
+  data.tar.gz: 68252e440ba5aad457873c11e4006e07498af01a339b807d8d5a2620e29e2d63
 SHA512:
-  metadata.gz: 96a5bafd4609f9502bb7d228b7fab60064560d35b10b78250c525981e797b2d052cce96e89ce3aa5edfd017a6fbafde24a44c6f96a8f63b392f27ec3c0b599d7
-  data.tar.gz: ac7a333d2ef31d24d9563dd63eabbfb9cc187140df38b6c0044d641a748d2d6326690d0222152e66810464371c43dcf92310677bbf32662c603e555558701a18
+  metadata.gz: 92b08d1c008377e9bffd4ca66fc6b7fa680bda7a2856a0eda10c62045eddf1e51c24e55074b34cf066d8f94c3412817c514f6a7a92bb23cab4c192c5a15f3b23
+  data.tar.gz: 814a61e039b60718acb159e33e4724eb59468857769363ec1746e4fbd14ebcccab4ff38ba462f145031dc647851cd15f454bfe165c66ff779b87f8bbe585d5d5

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at hello@belvo.co. All
+reported by contacting the project team at hello@belvo.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (0.6.0)
+    belvo (0.8.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.25.0)
+    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.com
+
+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
 
@@ -32,14 +41,15 @@ require 'belvo'
 belvo = Belvo::Client.new(
   'af6e69ff-43fa-4e10-8d90-3d217309a1e5',
   'gdi64m68Lc6xUjIKN3aJF2fZd51wD36lTjGVyJO5xQBfL7PRsgFef-ADXBxIhUnd',
-  'https://sandbox.belvo.co'
+  'https://sandbox.belvo.com'
 )
 
 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'])
@@ -51,6 +61,8 @@ rescue Belvo::RequestError => e
 end
 ```
 
+**Note:** If you create a `Link` without specifying [access_mode](https://docs.belvo.com/#operation/RegisterLink), the SDK will respect the default value from the API.
+
 ## Development
 
 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.

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.com']
   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,12 +63,24 @@ 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
       @invoices = Invoice.new @session
     end
 
+    # Provides access to TaxComplianceStatus resource
+    # @return [TaxComplianceStatus]
+    def tax_compliance_status
+      @tax_compliance_status = TaxComplianceStatus.new @session
+    end
+
     # Provides access to TaxReturns resource
     # @return [TaxReturn]
     def tax_returns

data/lib/belvo/http.rb

@@ -120,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.
@@ -101,6 +117,21 @@ module Belvo
   )
   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
+  )
+  end
+
   # @!class TaxReturnOptions < Faraday::Options
   # Contains configurable properties of a TaxReturn
   # @!attribute save_data [rw] Should data be persisted or not.
@@ -130,4 +161,13 @@ module Belvo
     :attach_pdf
   )
   end
+  # @!class WidgetTokenOptions < Faraday::Options
+  # Contains configurable properties of a WidgetToken
+  # @!attribute scopes [rw] Should have WidgetToken's permssions.
+  # @!attribute link_id [rw] Should the WidgetToken be tied to a specific link.
+  class WidgetTokenOptions < Faraday::Options.new(
+    :scopes,
+    :link_id
+  )
+  end
 end

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
@@ -309,6 +337,38 @@ module Belvo
     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
+    def initialize(session)
+      super(session)
+      @endpoint = 'tax-compliance-status/'
+    end
+
+    # Retrieve tax compliance status information from a specific fiscal link.
+    # @param link [String] Link UUID
+    # @param options [TaxComplianceStatusOptions] Configurable properties
+    # @return [Hash] created tax compliance status details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = TaxComplianceStatusOptions.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 'TaxComplianceStatus does not support'\
+            ' resuming a session'
+    end
+  end
+
   # A Tax return is the representation of the tax return document sent every
   # year by a person or a business to the tax authority in the country.
   class TaxReturn < Resource
@@ -393,12 +453,14 @@ module Belvo
       @endpoint = 'token/'
     end
 
-    def create
+    def create(options: nil)
+      options = WidgetTokenOptions.from(options)
       body = {
         id: @session.key_id,
         password: @session.key_password,
         scopes: 'read_institutions,write_links,read_links,delete_links'
-      }
+      }.merge(options)
+      body = clean body: body
       @session.post(@endpoint, body)
     end
   end

data/lib/belvo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2021-02-03 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.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: The Ruby gem for the Belvo API