belvo 0.6.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b549a9348810743f778ef07fb248f62c4aba55dbc95635c8696f9db4d0cf6f81
-  data.tar.gz: 817209595c82f407f57ddc8e8f7e22ecd356f83537245d2d8e4ac880095924c1
+  metadata.gz: 1c80936557b157355a2c887ae95cbcb84ce6eb83050fe10e6a250aa1773107b5
+  data.tar.gz: 95c3ae780b1e4400346bebb7d3f8b741081183cab3c56b516bd7a853214f095b
 SHA512:
-  metadata.gz: a4b73cdfdb9881f883bf7a916295558ef84adcaf9cce3dd6179cf2275494b8d0f3e87a31319493112a50ce474fa6358de4a759d52437bdb4fdcbf26edeefa3b9
-  data.tar.gz: ec2c9e7bbb340a53d6424c1f37c4e81d5b4dbc3b526903ef2d1b0c481f4887f9f7363e361e764cb6a5b03dd40c1290ef8b6416c43ebe06b32d91415b2a5dfd8d
+  metadata.gz: 6cbaed715376a6f82937ed331f5d1ed1d764b9bcbef36110414501dffa1e1ed7f711492542c58699bc9469302a2ab5fbe053d4ce64a19224473e3806f012d7c5
+  data.tar.gz: 1adb287f2022e560a0d4887e6829dc2807c556b44223ad485b11465110e2351d8e27e2bf5a58fa55d945d38836e475791e1567587647c48970265eb750f63d7e

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.3)
+    belvo (0.11.0)
       faraday
       faraday_middleware
       typhoeus

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/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,15 @@ 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.
+  # @!attribute widget [rw] Should have the Widget branding params.
+  class WidgetTokenOptions < Faraday::Options.new(
+    :scopes,
+    :link,
+    :widget
+  )
+  end
 end

data/lib/belvo/resources.rb

@@ -337,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
@@ -421,12 +453,20 @@ module Belvo
       @endpoint = 'token/'
     end
 
-    def create
+    def create(options: nil)
+      options = WidgetTokenOptions.from(options)
+      link_id = options.link
+      widget = options.widget
+      options.delete('link')
+      options.delete('widget')
       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',
+        link_id: link_id,
+        widget: widget
+      }.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.3'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.11.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2021-03-01 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: []