belvo 0.6.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8746f7636ac5bd7c67d0041ec84aa9240d9477687d98f826c28ea22135beb9c7
-  data.tar.gz: 91849cb78edce6d00eb636c29334b6eb4c958cf4e089ce734e5bda2f74fe3f54
+  metadata.gz: 6150c59072311f999fdf0934649e9c80e5ce536722965f14f6e8f65d36e0c22d
+  data.tar.gz: cb5f4b3f89834b67f0b263e2ac4155aec22ef660557013fc4226abf832a77273
 SHA512:
-  metadata.gz: 7e9f1c00f82387e356be66ce824cf97b0eb11472e8eb738e5e5db759317e957b9908238187f199b74844587fac9db3f4f4854c7eaf855b58cbf46ee1a395c886
-  data.tar.gz: 4d88c38fca8ca0e206844f7e0bedd33b323e6fba76f14cc30aa1adee405d252978cd373282952dacb581aede77af9b6db8046078e90c054545b6af88e179bbed
+  metadata.gz: c71e72f9a50de5f5996102a9f3259d46265a5d114533d541c18444be77f528f0dc976ef099094155e00dcd29ecc849408f1e2bc927484c6d2e3636e942d90b3c
+  data.tar.gz: aceb91b3c249d0356fedabb964b8e0f35f11cd76325df175aa266cd140d261ae751caf1d84559897d07f9b208700f798e87becf8ddbe1a8622a66e3f198437ac

data/.travis.yml

@@ -14,4 +14,5 @@ deploy:
   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.1)
+    belvo (0.9.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 = ['sdks@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

@@ -75,6 +75,12 @@ module Belvo
       @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

@@ -8,6 +8,7 @@ module Belvo
   # @!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
@@ -15,6 +16,7 @@ module Belvo
     :access_mode,
     :token,
     :username2,
+    :username3,
     :password2,
     :encryption_key,
     :username_type,
@@ -115,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.
@@ -144,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 [rw] Should the WidgetToken be tied to a specific link.
+  class WidgetTokenOptions < Faraday::Options.new(
+    :scopes,
+    :link
+  )
+  end
 end

data/lib/belvo/resources.rb

@@ -93,7 +93,7 @@ module Belvo
         institution: institution,
         username: username,
         password: password,
-        access_mode: options.access_mode || AccessMode::SINGLE
+        access_mode: options.access_mode
       }.merge(options)
       body = clean body: body
       @session.post(@endpoint, body)
@@ -122,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
@@ -325,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
@@ -409,12 +453,17 @@ module Belvo
       @endpoint = 'token/'
     end
 
-    def create
+    def create(options: nil)
+      options = WidgetTokenOptions.from(options)
+      link_id = options.link
+      options.delete('link')
       body = {
         id: @session.key_id,
         password: @session.key_password,
-        scopes: 'read_institutions,write_links,read_links,delete_links'
-      }
+        scopes: 'read_institutions,write_links,read_links,delete_links',
+        link_id: link_id
+      }.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.1'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2021-02-16 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:
-- sdks@belvo.co
+- sdks@belvo.com
 executables: []
 extensions: []
 extra_rdoc_files: []