belvo 0.19.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455f08aad36bb45f904a6c06fd63b46a91f320d20add273c8362e64d61d9e2a9
-  data.tar.gz: 674222f146ca510d11aee096a80c92b6b492ac37c1b56d9995d8524fc326c066
+  metadata.gz: 77535d19fd4a624ef494fa4c6354fc427bbfa388122398bace8dbe011207a006
+  data.tar.gz: e7655524ec6125db8fadb1f1b7fbee29e82685a4ead7edfecaec56a618f09bda
 SHA512:
-  metadata.gz: 1020a9ca2b693f828453c35b960909a287948c441846873ad046d6dd74007f95682d929f1bca7c030bee692ffece52fa9d9a7d83e5e8b71dc353f23736eadda2
-  data.tar.gz: eb1609e92f2b796b7a57aefdd9ef6dc64b89400efebc9f250bde379ffe4ee4dee59ed4c1fe9d8bbb22d92e6a8a6e79d0ed35a85107a878bddd08e2d00616b221
+  metadata.gz: 6366c18991ba3ff5b24efbfde467560a05d52d1392f349cf8a38c0515a59bba430fa2456e0fbcf35fdc89a0a28cdd43756371e5bc0dcc106afc6e03e3f845bac
+  data.tar.gz: 2ea9b99bd9dba5890256ca1c3404943d08b606187f8ecf6453f133d047955fca96691224b98d816699144bb6110353902b71e3543934e858d1834c76762630db

data/.github/workflows/generate-docs.yml

@@ -0,0 +1,26 @@
+name: Build & deploy Ruby SDK documentation
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Update gh-pages with docs
+    steps:
+      - name: Checkout Belvo Ruby SDK repo
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: "2.7"
+      - name: Install required gem dependencies
+        run: gem install yard --no-document
+      - name: Build RUBY SDK docs with YARD
+        run: yardoc --output-dir docs
+      - name: Deploy docs to gh-pages branch
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+          publish_branch: gh-pages

data/.rubocop.yml

@@ -25,3 +25,6 @@ Style/HashTransformKeys:
 
 Style/HashTransformValues:
   Enabled: true
+
+RSpec/MultipleExpectations:
+  Max: 2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (0.19.3)
+    belvo (1.1.0)
       faraday
       faraday_middleware
       typhoeus
@@ -11,8 +11,8 @@ GEM
   specs:
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
-    claide (1.0.3)
+    ast (2.4.2)
+    claide (1.1.0)
     claide-plugins (0.9.2)
       cork
       nap
@@ -20,12 +20,13 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    coveralls_reborn (0.23.0)
+    coveralls_reborn (0.24.0)
       simplecov (>= 0.18.1, < 0.22.0)
       term-ansicolor (~> 1.6)
       thor (>= 0.20.3, < 2.0)
       tins (~> 1.16)
-    crack (0.4.4)
+    crack (0.4.5)
+      rexml
     danger (8.2.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
@@ -39,54 +40,74 @@ GEM
       no_proxy_fix
       octokit (~> 4.7)
       terminal-table (~> 1)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     docile (1.4.0)
-    ethon (0.14.0)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
-    faraday (1.1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
     faraday-http-cache (2.2.0)
       faraday (>= 0.8)
-    faraday_middleware (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
-    ffi (1.15.3)
-    git (1.8.1)
+    ffi (1.15.5)
+    git (1.11.0)
       rchardet (~> 1.8)
     hashdiff (1.0.1)
     jaro_winkler (1.5.4)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     multipart-post (2.1.1)
     nap (1.1.0)
     no_proxy_fix (0.1.2)
-    octokit (4.21.0)
+    octokit (4.22.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.20.0)
-    parser (2.7.2.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
     rake (12.3.3)
     rchardet (1.8.0)
     rexml (3.2.5)
-    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)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rubocop (0.81.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -97,8 +118,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-rspec (1.41.0)
       rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -107,20 +128,20 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+    simplecov_json_formatter (0.1.4)
     sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (1.1.0)
-    tins (1.29.1)
+    thor (1.2.1)
+    tins (1.31.0)
       sync
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    unicode-display_width (1.7.0)
-    webmock (3.9.5)
-      addressable (>= 2.3.6)
+    unicode-display_width (1.8.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 

data/README.md

@@ -53,7 +53,9 @@ begin
     
     belvo.accounts.retrieve(link: link_id)
 
-    puts belvo.accounts.list
+    belvo.accounts.list.each do |item|
+        puts item
+    end
 rescue Belvo::RequestError => e
     puts e.status_code
     puts e.detail
@@ -79,17 +81,31 @@ begin
         username: 'janedoe', 
         password: 'super-secret',
         options: { access_mode: Belvo::Link::AccessMode::SINGLE }
-        )
+    )
     
     belvo.accounts.retrieve(link: new_link['id'])
 
-    puts belvo.accounts.list
+    belvo.accounts.list.each do |item|
+        puts item
+    end
 rescue Belvo::RequestError => e
     puts e.status_code
     puts e.detail
 end
 ```
 
+## Pagination
+
+All `list` methods only return the first page of results. If you want to iterate by all pages, you will need to specify the `page` as a parameter:
+
+```ruby
+    #`api/transactions`
+    ...
+    belvo.transactions.list(params: {page: "2"})
+    ...
+```
+When the result of your call is `nil`, this indicates that there are no more pages to iterate over. 
+
 **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

data/lib/belvo/http.rb

@@ -51,7 +51,7 @@ module Belvo
     # @return [Boolean] True if credentials are valid to authenticate
     #   to Belvo API else False.
     def authenticate
-      @session.basic_auth(@key_id, @key_password)
+      @session.request(:basic_auth, @key_id, @key_password)
       response = @session.get('api/')
       response.success?
     end
@@ -91,16 +91,8 @@ module Belvo
     # @raise [RequestError] If response code is different than 2XX
     def list(path, params: nil)
       params = {} if params.nil?
-      loop do
-        response = get(path, params: params)
-        response.body['results'].each do |item|
-          yield item if block_given?
-        end
-
-        break unless response.body['next']
-
-        params = Faraday::Utils.parse_query URI(response.body['next']).query
-      end
+      response = get(path, params: params)
+      response.body['results']
     end
 
     # Show specific resource details

data/lib/belvo/options.rb

@@ -152,9 +152,28 @@ module Belvo
   )
   end
 
+  # @!class TaxRetentionsOptions < Faraday::Options
+  # Contains configurable properties of a tax retention
+  # @!attribute save_data [rw] Indicates whether or not to persist the
+  # data in Belvo. By default, this is set to `true` and we return a
+  # 201 Created response. When set to `false`, the data won't be persisted
+  # and we return a 200 OK response.
+  # @!attribute attach_xml [rw] When set to `true`, you will receive the XML
+  # tax retention in the response.
+  class TaxRetentionsOptions < Faraday::Options.new(
+    :save_data,
+    :attach_xml,
+    :date_from,
+    :date_to
+  )
+  end
+
   # @!class TaxStatusOptions < Faraday::Options
   # Contains configurable properties of a TaxStatus
-  # @!attribute save_data [rw] Should data be persisted or not.
+  # @!attribute save_data [rw] Indicates whether or not to persist the data
+  # in Belvo. By default, this is set to `true` and we return a 201 Created
+  # response. When set to `false`, the data won't be persisted and we return
+  # a 200 OK response.
   # @!attribute token [rw] OTP token required by the institution
   # @!attribute attach_pdf [rw] Should the PDF file be included in the
   #   response or not.

data/lib/belvo/resources.rb

@@ -25,12 +25,11 @@ module Belvo
 
     # List all results
     # @param params [Hash] Extra parameters sent as query strings.
-    # @return [Array]
+    # @return [Array] List of results when no block is passed.
+    # @yield [Hash] Each result to be processed individually.
     # @raise [RequestError] If response code is different than 2XX
     def list(params: nil)
-      results = []
-      @session.list(@endpoint, params: params) { |item| results.push item }
-      results
+      @session.list(@endpoint, params: params)
     end
 
     # Show specific resource details
@@ -473,6 +472,48 @@ module Belvo
     end
   end
 
+  # A tax retention is the amount of money that the payer must deduct from the
+  # total amount of a purchase invoice, according to the regulations of the
+  # fiscal institution.
+  class TaxRetentions < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'api/tax-retentions/'
+    end
+
+    class TaxRetentionsType
+      INFLOW = 'inflow'
+      OUTFLOW = 'outflow'
+    end
+
+    # Retrieve tax retentions from a specific fiscal link.
+    # @param link [String] The `link.id` that you want to get information
+    # for (UUID).
+    # @param type [TaxRetentionsType] The type of tax retention in relation to
+    # the invoice (from the perspective of the Link owner). `OUTFLOW` relates
+    # to a tax retention for a sent invoice. `INFLOW` relates to a tax
+    # retention for a received invoice. (inflow or outflow)
+    # @param options [TaxRetentionsOptions] Configurable properties
+    def retrieve(link:, type:, options: nil)
+      options = TaxRetentionsOptions.from(options)
+      body = {
+        link: link,
+        date_from: options.date_from,
+        date_to: options.date_to,
+        save_data: options.save_data,
+        attach_xml: options.attach_xml,
+        type: type
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+
+    def resume(_session_id, _token, _link: nil)
+      raise NotImplementedError \
+        'TaxRetentions does not support resuming a session'
+    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
@@ -499,7 +540,8 @@ module Belvo
     end
 
     def resume(_session_id, _token, _link: nil)
-      raise NotImplementedError 'TaxReturn does not support resuming a session.'
+      raise NotImplementedError \
+        'TaxRetentions does not support resuming a session.'
     end
   end
 

data/lib/belvo/version.rb

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

data/lib/belvo.rb

@@ -110,7 +110,13 @@ module Belvo
       @tax_status = TaxStatus.new @session
     end
 
-    # Provides access to Instituions resource
+    # Provides access to the TaxRetentions resource
+    # @return [TaxRetentions]
+    def tax_retentions
+      @tax_retentions = TaxRetentions.new @session
+    end
+
+    # Provides access to the Institutions resource
     # @return [Institution]
     def institutions
       @institutions = Institution.new @session

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.19.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -152,6 +152,7 @@ files:
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
 - ".github/workflows/danger-pr-reviews.yml"
+- ".github/workflows/generate-docs.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -194,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
 summary: The Ruby gem for the Belvo API