belvo 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 759f6f987ab53c7befec57c77cdfb6382c828afe83ca304dcfc7ca06f6f816c8
-  data.tar.gz: 6d600dbc5a78cec15a6008a24004ca333b645fb2b671f3e78deb94ec12a54fa0
+  metadata.gz: 5c1dcb245d74ddc040cd5e0f820ff9ecefa761e0135ee16fe5b08a6bf89dae26
+  data.tar.gz: d2a243cd3f86fd7bb295a8fd85dab1e7226aa95f60ee5d8c30a5b3905dcd9918
 SHA512:
-  metadata.gz: d1bcdaf03338f5044a3197b21c1cbfd1290143833f4062162ca40c9428053a89625ba2e4b8829ca9cde2bc8525d4b9329cb91ad81f7d81a410c68149983df7ca
-  data.tar.gz: c27cc39ba3bf8c70068254ea9e48dd29dd19850b0f11d411520a512ab3f72b5c1b57b3fb2d67c8717062783c7282a31d86972c8da00fcded05c7fd71530047f6
+  metadata.gz: 96a5bafd4609f9502bb7d228b7fab60064560d35b10b78250c525981e797b2d052cce96e89ce3aa5edfd017a6fbafde24a44c6f96a8f63b392f27ec3c0b599d7
+  data.tar.gz: ac7a333d2ef31d24d9563dd63eabbfb9cc187140df38b6c0044d641a748d2d6326690d0222152e66810464371c43dcf92310677bbf32662c603e555558701a18

data/.codeclimate.yml

@@ -0,0 +1,6 @@
+engines:
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Style/MutableConstant:
+        enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (0.3.0)
+    belvo (0.6.0)
       faraday
       faraday_middleware
       typhoeus
@@ -34,9 +34,9 @@ GEM
     json (2.3.0)
     multipart-post (2.1.1)
     parallel (1.19.1)
-    parser (2.7.1.0)
+    parser (2.7.1.2)
       ast (~> 2.4.0)
-    public_suffix (4.0.4)
+    public_suffix (4.0.5)
     rainbow (3.0.0)
     rake (12.3.3)
     rexml (3.2.4)
@@ -44,15 +44,15 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
     rubocop (0.81.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -61,7 +61,7 @@ GEM
       rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-rspec (1.38.1)
+    rubocop-rspec (1.39.0)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
@@ -74,9 +74,9 @@ GEM
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (1.0.1)
-    tins (1.24.1)
+    tins (1.25.0)
       sync
-    typhoeus (1.3.1)
+    typhoeus (1.4.0)
       ethon (>= 0.9.0)
     unicode-display_width (1.7.0)
     webmock (3.8.3)

data/lib/belvo.rb

@@ -75,10 +75,22 @@ module Belvo
       @tax_returns = TaxReturn.new @session
     end
 
+    # Provides access to TaxStatus resource
+    # @return [TaxStatus]
+    def tax_status
+      @tax_status = TaxStatus.new @session
+    end
+
     # Provides access to Instituions resource
     # @return [Institution]
     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)

data/lib/belvo/options.rb

@@ -8,10 +8,14 @@ module Belvo
   # @!attribute access_mode [rw] Link access mode (SINGLE or RECURRENT)
   # @!attribute token [rw] OTP token required by the institution
   # @!attribute encryption_key [rw] Custom encryption key
+  # @!attribute username_type [rw] Type of the username provided
   class LinkOptions < Faraday::Options.new(
     :access_mode,
     :token,
-    :encryption_key
+    :encryption_key,
+    :username_type,
+    :certificate,
+    :private_key
   )
   end
 
@@ -111,4 +115,19 @@ module Belvo
     :attach_pdf
   )
   end
+
+  # @!class TaxStatusOptions < Faraday::Options
+  # Contains configurable properties of a TaxStatus
+  # @!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 TaxStatusOptions < Faraday::Options.new(
+    :token,
+    :encryption_key,
+    :save_data,
+    :attach_pdf
+  )
+  end
 end

data/lib/belvo/resources.rb

@@ -2,6 +2,7 @@
 
 require 'date'
 require 'belvo/options'
+require 'belvo/utils'
 
 module Belvo
   # Represents a consumable REST resource from Belvo API
@@ -23,11 +24,12 @@ module Belvo
     end
 
     # List all results
+    # @param params [Hash] Extra parameters sent as query strings.
     # @return [Array]
     # @raise [RequestError] If response code is different than 2XX
-    def list
+    def list(params: nil)
       results = []
-      @session.list(@endpoint) { |item| results.push item }
+      @session.list(@endpoint, params: params) { |item| results.push item }
       results
     end
 
@@ -87,6 +89,8 @@ module Belvo
       options: nil
     )
       options = LinkOptions.from(options)
+      options.certificate = Utils.read_file_to_b64(options.certificate)
+      options.private_key = Utils.read_file_to_b64(options.private_key)
       body = {
         institution: institution,
         username: username,
@@ -94,7 +98,10 @@ module Belvo
         password2: password2,
         token: options.token,
         encryption_key: options.encryption_key,
-        access_mode: options.access_mode || AccessMode::SINGLE
+        access_mode: options.access_mode || AccessMode::SINGLE,
+        username_type: options.username_type,
+        certificate: options.certificate,
+        private_key: options.private_key
       }.merge(options)
       body = clean body: body
       @session.post(@endpoint, body)
@@ -107,13 +114,18 @@ module Belvo
     # @param options [LinkOptions] Configurable properties
     # @return [Hash] link details
     # @raise [RequestError] If response code is different than 2XX
-    def update(id:, password:, password2: nil, options: nil)
+    def update(id:, password: nil, password2: nil, options: nil)
       options = LinkOptions.from(options)
+      options.certificate = Utils.read_file_to_b64(options.certificate)
+      options.private_key = Utils.read_file_to_b64(options.private_key)
       body = {
         password: password,
         password2: password2,
         token: options.token,
-        encryption_key: options.encryption_key
+        encryption_key: options.encryption_key,
+        username_type: options.username_type,
+        certificate: options.certificate,
+        private_key: options.private_key
       }.merge(options)
       body = clean body: body
       @session.put(@endpoint, id, body)
@@ -131,7 +143,7 @@ module Belvo
     # Retrieve accounts from an existing link
     # @param link [String] Link UUID
     # @param options [AccountOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created accounts details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, options: nil)
       options = AccountOptions.from(options)
@@ -158,7 +170,7 @@ module Belvo
     # @param link [String] Link UUID
     # @param date_from [String] Date string (YYYY-MM-DD)
     # @param options [TransactionOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created transactions details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, date_from:, options: nil)
       options = TransactionOptions.from(options)
@@ -188,7 +200,7 @@ module Belvo
     # Retrieve owners from an existing link
     # @param link [String] Link UUID
     # @param options [OwnerOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created owners details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, options: nil)
       options = OwnerOptions.from(options)
@@ -215,7 +227,7 @@ module Belvo
     # @param link [String] Link UUID
     # @param date_from [String] Date string (YYYY-MM-DD)
     # @param options [BalanceOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created balances details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, date_from:, options: nil)
       options = BalanceOptions.from(options)
@@ -246,7 +258,7 @@ module Belvo
     # @param year [Integer]
     # @param month [Integer]
     # @param options [StatementOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created statement details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, account:, year:, month:, options: nil)
       options = StatementOptions.from(options)
@@ -278,7 +290,7 @@ module Belvo
     # @param date_from [String] Date string (YYYY-MM-DD)
     # @param date_to [String] Date string (YYYY-MM-DD)
     # @param options [InvoiceOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created invoices details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, date_from:, date_to:, type:, options: nil)
       options = InvoiceOptions.from(options)
@@ -310,7 +322,7 @@ module Belvo
     # @param year_from [Integer]
     # @param year_to [Integer]
     # @param options [TaxReturnOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created tax returns details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, year_from:, year_to:, options: nil)
       options = TaxReturnOptions.from(options)
@@ -332,6 +344,37 @@ module Belvo
     end
   end
 
+  # A Tax status is the representation of the tax situation of a person or a
+  # business to the tax authority in the country.
+  class TaxStatus < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'tax-status/'
+    end
+
+    # Retrieve tax status information from a specific fiscal link.
+    # @param link [String] Link UUID
+    # @param options [TaxStatusOptions] Configurable properties
+    # @return [Hash] created tax status details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = TaxStatusOptions.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 'TaxReturn does not support resuming a session.'
+    end
+  end
+
   # An Institution is an entity that Belvo can access information from. It can
   # be a bank or fiscal type of institutions such as the SAT in Mexico.
   class Institution < Resource
@@ -340,4 +383,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/utils.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+# Class with helper functions
+class Utils
+  def self.read_file_to_b64(path)
+    return if path.nil? || !File.file?(path)
+
+    data = File.open(path).read
+    Base64.encode64(data)
+  end
+end

data/lib/belvo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -146,6 +146,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
 - ".gitignore"
@@ -166,6 +167,7 @@ files:
 - lib/belvo/http.rb
 - lib/belvo/options.rb
 - lib/belvo/resources.rb
+- lib/belvo/utils.rb
 - lib/belvo/version.rb
 homepage: https://github.com/belvo-finance/belvo-ruby
 licenses:
@@ -189,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: The Ruby gem for the Belvo API