belvo 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eec099b22dbcb9dbac55982ac84c447bdae2f69c5f06bb310ea8a1be8889b1d
-  data.tar.gz: dfe77adac6722c395f8b31c867a2a803dabd226fcbda6452ffb29dbe6310e412
+  metadata.gz: 53c6172de053ccd0f9028de57bcbf117bf70203d145d43683aa2bb9ea655ff07
+  data.tar.gz: 68252e440ba5aad457873c11e4006e07498af01a339b807d8d5a2620e29e2d63
 SHA512:
-  metadata.gz: 71f7405acc9de362147b1182644c0af7bfe358160d070eaaae59b41d95caec18800d9bb589e61ef7dd0ae6ef2c22418cda0dfcd636d1f5165ae430d01b5dd0be
-  data.tar.gz: 90c3ce711c21df50880301629d3555f8dff981441e1dc30e1065e5182550dfd1e1bf43e282d47e58da05cd8131669eb00974f48aa7879ca22c06cf11b94d46a7
+  metadata.gz: 92b08d1c008377e9bffd4ca66fc6b7fa680bda7a2856a0eda10c62045eddf1e51c24e55074b34cf066d8f94c3412817c514f6a7a92bb23cab4c192c5a15f3b23
+  data.tar.gz: 814a61e039b60718acb159e33e4724eb59468857769363ec1746e4fbd14ebcccab4ff38ba462f145031dc647851cd15f454bfe165c66ff779b87f8bbe585d5d5

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

data/README.md

@@ -9,7 +9,7 @@
 ## 📕 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
+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)
@@ -41,7 +41,7 @@ require 'belvo'
 belvo = Belvo::Client.new(
   'af6e69ff-43fa-4e10-8d90-3d217309a1e5',
   'gdi64m68Lc6xUjIKN3aJF2fZd51wD36lTjGVyJO5xQBfL7PRsgFef-ADXBxIhUnd',
-  'https://sandbox.belvo.co'
+  'https://sandbox.belvo.com'
 )
 
 begin
@@ -61,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

@@ -117,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.
@@ -146,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

@@ -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,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.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-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:
-- sdks@belvo.co
+- sdks@belvo.com
 executables: []
 extensions: []
 extra_rdoc_files: []