belvo 0.8.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53c6172de053ccd0f9028de57bcbf117bf70203d145d43683aa2bb9ea655ff07
-  data.tar.gz: 68252e440ba5aad457873c11e4006e07498af01a339b807d8d5a2620e29e2d63
+  metadata.gz: 7f69b2401f03d00f211b1029e686b5ecb35b717bdff42dcbac781e207b2feb87
+  data.tar.gz: f93e791acf610e5b1d3f9e3df2fd4cc161003b03d9a303ee66b5ada7c6857b5e
 SHA512:
-  metadata.gz: 92b08d1c008377e9bffd4ca66fc6b7fa680bda7a2856a0eda10c62045eddf1e51c24e55074b34cf066d8f94c3412817c514f6a7a92bb23cab4c192c5a15f3b23
-  data.tar.gz: 814a61e039b60718acb159e33e4724eb59468857769363ec1746e4fbd14ebcccab4ff38ba462f145031dc647851cd15f454bfe165c66ff779b87f8bbe585d5d5
+  metadata.gz: 5e2ba29bf5d230d3f250b9dd3c284f09a01fe0dad4d05b29f6e360392258d5d6e5e93c056863345e6aeb22665fb934368e8b6ca5eac76c4e4089b8eda178d637
+  data.tar.gz: b124c2ce6c01aed682954cc6ee9f08c6f3507c6bee994249466c9f013992b5830e7649aee52032a56f7b20e12722229c7ccf84c9c7cb26db23e742e26051c7e0

data/.github/workflows/danger-pr-reviews.yml

@@ -0,0 +1,48 @@
+name: Run Danger
+
+on: [pull_request]
+
+jobs:
+  build:
+    name: Run Danger
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+
+      # Setup ruby
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      # Install the right bundler version
+      - name: Install bundler
+        run: gem install bundler
+
+      # Cache dependencies
+      - name: Cache ruby dependencies
+        id: cache-ruby
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: union-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            union-gems-
+      # Install dependencies on cache miss
+      - name: Install ruby dependencies
+        if: steps.cache-ruby.outputs.cache-hit != 'true'
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3 --without=documentation
+      # Run danger
+      - name: Run danger
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          bundle config path vendor/bundle
+          bundle exec danger
+

data/Dangerfile

@@ -0,0 +1,21 @@
+# rubocop:disable all
+# Mainly to encourage writing up some reasoning about the PR, rather than
+# just leaving a title
+fail "Please provide a short summary in the PR description :page_with_curl:" if github.pr_body.length < 10
+
+# The title should include the correct prefix tag
+if !github.pr_title.match(/^\[(?:Fixed|Added|Changed|Removed|Security|Other)\]/)
+	fail "Please provide a valid PR title label: [Added]/[Fixed]/[Changed]/[Removed]/[Security]/[Other]"
+end
+
+# The title should include the JIRA ticket unless is a dependabot PR
+if github.pr_labels.include?("dependencies")
+	message ("PR autogenerated by dependabot")
+elsif !github.pr_title.match(/^\[.*\]\s?\[BEL-\d+\]/)
+	fail "Please provide a valid Jira ticket ID associated to this PR: [BEL-XXXX]. If you do not have any associated Jira ticket, just use [BEL-XXXX]"
+end
+
+warn("PR is classed as Work in Progress", sticky: false) if github.pr_title.include? "[WIP]"
+
+message("One approval required for merging :smiley_cat: :smiley_cat:")
+# rubocop:enable all

data/Gemfile

@@ -1,3 +1,4 @@
+# rubocop:disable all
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
@@ -13,4 +14,6 @@ gem 'rspec', '~> 3.0'
 gem 'rubocop', '~> 0.81.0', require: false
 gem 'rubocop-rspec', require: false
 gem 'typhoeus'
+gem 'danger', '8.2.1'
 gem 'webmock'
+# rubocop:enable all

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (0.8.0)
+    belvo (0.13.0)
       faraday
       faraday_middleware
       typhoeus
@@ -12,6 +12,14 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -19,6 +27,19 @@ GEM
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
     crack (0.4.4)
+    danger (8.2.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
     diff-lcs (1.4.4)
     docile (1.3.2)
     ethon (0.12.0)
@@ -26,20 +47,35 @@ GEM
     faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     ffi (1.13.1)
+    git (1.8.1)
+      rchardet (~> 1.8)
     hashdiff (1.0.1)
     jaro_winkler (1.5.4)
     json (2.3.1)
+    kramdown (2.3.1)
+      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)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
     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)
+    rchardet (1.8.0)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -65,6 +101,9 @@ GEM
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -73,6 +112,8 @@ GEM
     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.0.1)
     tins (1.26.0)
       sync
@@ -90,6 +131,7 @@ PLATFORMS
 DEPENDENCIES
   belvo!
   coveralls
+  danger (= 8.2.1)
   faraday
   faraday_middleware
   rake (~> 12.0)

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Belvo
+Copyright (c) 2020 Belvo Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -73,6 +73,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/belvo-finance/belvo-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/belvo-finance/belvo-ruby/blob/master/CODE_OF_CONDUCT.md).
 
+If you wish to submit a pull request, please be sure check the items on this list:
+- [ ] Tests related to the changed code were executed
+- [ ] The source code has been coded following the OWASP security best practices (https://owasp.org/www-pdf-archive/OWASP_SCP_Quick_Reference_Guide_v2.pdf).
+- [ ] Commit message properly labeled
+- [ ] There is a ticket associated to each PR. 
+
 
 ## Code of Conduct
 

data/lib/belvo/http.rb

@@ -99,8 +99,7 @@ module Belvo
 
         break unless response.body['next']
 
-        path = response.body['next']
-        params = nil
+        params = Faraday::Utils.parse_query URI(response.body['next']).query
       end
     end
 

data/lib/belvo/options.rb

@@ -21,7 +21,8 @@ module Belvo
     :encryption_key,
     :username_type,
     :certificate,
-    :private_key
+    :private_key,
+    :external_id
   )
   end
 
@@ -143,7 +144,8 @@ module Belvo
     :token,
     :encryption_key,
     :save_data,
-    :attach_pdf
+    :attach_pdf,
+    :type
   )
   end
 
@@ -164,10 +166,12 @@ module Belvo
   # @!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.
+  # @!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_id
+    :link,
+    :widget
   )
   end
 end

data/lib/belvo/resources.rb

@@ -134,6 +134,24 @@ module Belvo
       }
       @session.token(@endpoint, id, body)
     end
+
+    # Patch an existing link
+    # @param id [String] Link UUID
+    # @param options [LinkOptions] Configurable properties
+    # @return [Hash] created link details
+    # @raise [RequestError] If response code is different than 2XX
+    def patch(
+      id:,
+      options: nil
+    )
+      options = LinkOptions.from(options)
+      body = {
+        access_mode: options.access_mode
+      }.merge(options)
+      body = clean body: body
+      resource_path = format('%<path>s%<id>s/', path: @endpoint, id: id)
+      @session.patch(resource_path, body)
+    end
   end
 
   # An Account is the representation of a bank account inside a financial
@@ -377,24 +395,35 @@ module Belvo
       @endpoint = 'tax-returns/'
     end
 
+    class TaxReturnType
+      YEARLY = 'yearly'
+      MONTHLY = 'monthly'
+    end
+
     # Retrieve tax returns information from a specific fiscal link.
     # @param link [String] Link UUID
-    # @param year_from [Integer]
-    # @param year_to [Integer]
+    # @param year_from [Integer] | [Date]
+    # @param year_to [Integer] | [Date]
     # @param options [TaxReturnOptions] Configurable properties
     # @return [Hash] created tax returns details
     # @raise [RequestError] If response code is different than 2XX
-    def retrieve(link:, year_from:, year_to:, options: nil)
+    def retrieve(link:, year_from: nil, year_to: nil, options: nil)
       options = TaxReturnOptions.from(options)
       body = {
         link: link,
-        year_from: year_from,
-        year_to: year_to,
         token: options.token,
         encryption_key: options.encryption_key,
         save_data: options.save_data || true,
-        attach_pdf: options.attach_pdf
+        attach_pdf: options.attach_pdf,
+        type: options.type
       }.merge(options)
+      if options.type == TaxReturnType::MONTHLY
+        body[:date_from] = year_from
+        body[:date_to] = year_to
+      else
+        body[:year_from] = year_from
+        body[:year_to] = year_to
+      end
       body = clean body: body
       @session.post(@endpoint, body)
     end
@@ -455,10 +484,16 @@ module Belvo
 
     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)

data/lib/belvo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -149,11 +149,13 @@ files:
 - ".codeclimate.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
+- ".github/workflows/danger-pr-reviews.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dangerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE