belvo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2399efd4e273fc2d474b7ef0db1c1b8607021ae7fb1268d4dfb0a94907eb808
+  data.tar.gz: 2bf08319b43e36e48a3d25788305c809b582d0688b6c8f1fbb624e4d6c3df6d1
+SHA512:
+  metadata.gz: '05288d5fda2ae4caa81434ff96505559be7f8097d8ce3c26fce38cb45fd84071228b5f4e946e145339f0687fd112f69d44f3a0748c9bed03ce3d7ff99843fd43'
+  data.tar.gz: 7bd0ca6155a93a57cbc51dce73fbf0dee7600fe1cac3b091d6778c518781b0a309e339d11c5498a37ef3e0d1d87fb946a22be3192678ec8fe38c4ffd660a342e

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,18 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Description of the problem
+
+## Expected impact
+
+## Proposed solution
+In this story, we will ...
+This is precisely how we will do it:
+
+- ...

data/.github/pull_request_template.md

@@ -0,0 +1,10 @@
+:question: What
+---
+<!-- Let us know what did you change in the code -->
+
+
+:speech_balloon: Why
+---
+<!-- Are there any arguments that will help to understand these changes? Okay, put'em here... -->
+
+<!-- If this PR Relates or Fixes an issue, please also add it --> 

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+require: rubocop-rspec
+
+RSpec/ExampleLength:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.1.4
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+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
+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.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in belvo.gemspec
+gemspec
+
+gem 'coveralls', require: false
+gem 'faraday'
+gem 'faraday_middleware'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 0.81.0', require: false
+gem 'rubocop-rspec', require: false
+gem 'typhoeus'
+gem 'webmock'

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    belvo (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    ffi (1.12.2)
+    hashdiff (1.0.1)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    multipart-post (2.1.1)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      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)
+      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)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-rspec (1.38.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.24.1)
+      sync
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.7.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  belvo!
+  coveralls
+  faraday
+  faraday_middleware
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.81.0)
+  rubocop-rspec
+  typhoeus
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Belvo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+<h1 align="center">Belvo Ruby Gem</h1>
+<p align="center">
+    <a href="https://travis-ci.com/belvo-finance/belvo-ruby"><img alt="Travis (.com)" src="https://img.shields.io/travis/com/belvo-finance/belvo-ruby/master?style=for-the-badge"></a>
+    <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>
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'belvo'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install belvo
+
+## Usage
+
+```ruby
+require 'belvo'
+
+belvo = Belvo::Client.new(
+  'af6e69ff-43fa-4e10-8d90-3d217309a1e5',
+  'gdi64m68Lc6xUjIKN3aJF2fZd51wD36lTjGVyJO5xQBfL7PRsgFef-ADXBxIhUnd',
+  'https://sandbox.belvo.co'
+)
+
+begin
+  new_link = belvo.links.retrieve(
+    institution: 'banamex_mx_retail', 
+    username: 'janedoe', 
+    password: 'super-secret'
+  )
+
+  belvo.accounts.retrieve(link: new_link['id'])
+
+  puts belvo.accounts.list
+rescue Belvo::RequestError => e
+  puts e.status_code
+  puts e.detail
+end
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+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).
+
+
+## Code of Conduct
+
+Everyone interacting in the Belvo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/belvo-finance/belvo-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/belvo.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/belvo/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'belvo'
+  spec.version = Belvo::VERSION
+  spec.authors = ['Belvo Finance S.L.']
+  spec.email = ['hello@belvo.co']
+
+  spec.summary = 'The Ruby gem for the Belvo API'
+  spec.description = %(Belvo is the leading Open Banking API platform in Latin
+                       America and the easiest way for users to connect their
+                       account to an app)
+  spec.homepage = 'https://github.com/belvo-finance/belvo-ruby'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/belvo-finance/belvo-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/belvo-finance/belvo-ruby/blob/master/README.md'
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'belvo'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/belvo.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'belvo/http'
+require 'belvo/exceptions'
+require 'belvo/resources'
+
+module Belvo
+  # Allows easy access to Belvo API servers.
+  class Client
+    # Current Belvo API session
+    # @return [APISession]
+    attr_reader :session
+
+    # @param secret_key_id [String]
+    # @param secret_key_password [String]
+    # @param url [String, nil] API host URL, can be set from the environment
+    #  using the variable name BELVO_API_URL
+    # @return [APISession] Authenticated Belvo API session
+    def initialize(secret_key_id, secret_key_password, url = nil)
+      (belvo_api_url = url) || ENV['BELVO_API_URL']
+      raise BelvoAPIError, 'You need to provide a URL.' if belvo_api_url.nil?
+
+      @session = Belvo::APISession.new(belvo_api_url)
+
+      return if @session.login(secret_key_id, secret_key_password)
+
+      raise BelvoAPIError, 'Login failed.'
+    end
+
+    # Provides access to Links resource
+    # @return [Link]
+    def links
+      @links = Link.new @session
+    end
+
+    # Provides access to Accounts resource
+    # @return [Account]
+    def accounts
+      @accounts = Account.new @session
+    end
+
+    # Provides access to Transactions resource
+    # @return [Transaction]
+    def transactions
+      @transactions = Transaction.new @session
+    end
+
+    # Provides access to Owners resource
+    # @return [Owner]
+    def owners
+      @owners = Owner.new @session
+    end
+
+    # Provides access to Balances resource
+    # @return [Balance]
+    def balances
+      @balances = Balance.new @session
+    end
+
+    # Provides access to Statements resource
+    # @return [Statement]
+    def statements
+      @statements = Statement.new @session
+    end
+
+    # Provides access to Invoices resource
+    # @return [Invoice]
+    def invoices
+      @invoices = Invoice.new @session
+    end
+
+    # Provides access to TaxReturns resource
+    # @return [TaxReturn]
+    def tax_returns
+      @tax_returns = TaxReturn.new @session
+    end
+  end
+end

data/lib/belvo/exceptions.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Belvo
+  # Belvo API base error
+  class BelvoAPIError < StandardError
+    # @param message [String] Error short description
+    def initialize(message)
+      super(message)
+    end
+  end
+
+  # Generic request error, any response with status different than 2xx.
+  class RequestError < BelvoAPIError
+    # HTTP code returned by Belvo API
+    # @return [Integer]
+    attr_reader :status_code
+
+    # Error message returned by Belvo API
+    # @return [JSON]
+    attr_reader :detail
+
+    # @param message [String] Error short description
+    # @param status_code [Integer] HTTP code
+    # @param detail [JSON] Detailed error(s) description
+    def initialize(message, status_code, detail)
+      super(message)
+      @status_code = status_code
+      @detail = detail
+    end
+  end
+end

data/lib/belvo/http.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+
+require 'belvo/version'
+require 'belvo/exceptions'
+
+module Belvo
+  # Describes a Belvo API session
+  class APISession
+    # @param url [String] Belvo API host url
+    # @return [Faraday::Connection]
+    def initialize(url)
+      @url = format('%<url>s/api/', url: url)
+      @session = Faraday::Connection.new(url: @url) do |faraday|
+        faraday.adapter :typhoeus
+        faraday.response :json
+        faraday.headers = {
+          'Content-Type' => 'application/json',
+          'User-Agent' => format(
+            'belvo-ruby (%<version>s)',
+            version: Belvo::VERSION
+          )
+        }
+      end
+    end
+
+    private
+
+    # Raise an error if the response code is not 2XX.
+    # @param response [Faraday::Response]
+    # @return [Faraday::Response]
+    def raise_for_status(response)
+      unless response.success?
+        raise RequestError.new(
+          'Request error',
+          response.status,
+          response.body.to_s
+        )
+      end
+      response
+    end
+
+    # Set and validate authentication credentials
+    # @return [Boolean] True if credentials are valid to authenticate
+    #   to Belvo API else False.
+    def authenticate
+      @session.basic_auth(@key_id, @key_password)
+      response = @session.get('')
+      response.success?
+    end
+
+    # Perform GET request to a Belvo API endpoint. Needed for Detail and List.
+    # @param path [String] API Endpoint
+    # @param params [Hash] Params to be send as querystring
+    # @return [Faraday::Response]
+    # @raise [RequestError] If response code is different than 2XX
+    def get(path, params: nil)
+      params = {} if params.nil?
+      response = @session.get(path) do |req|
+        req.params = params
+      end
+      raise_for_status response
+    end
+
+    public
+
+    # Authenticate to Belvo API using the given credentials.
+    # @param secret_key_id [String]
+    # @param secret_key_password [String]
+    # @return [Boolean] True if credentials are valid to authenticate
+    #   to Belvo API else False.
+    def login(secret_key_id, secret_key_password)
+      @key_id = secret_key_id
+      @key_password = secret_key_password
+
+      authenticate
+    end
+
+    # List results from an API endpoint. It will yield all results following
+    # pagination's next page, if any.
+    # @param path [String] API endpoint
+    # @param params [Hash] Params to be send as querystring
+    # @yield [Hash] Each result
+    # @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']
+
+        path = response.body['next']
+        params = nil
+      end
+    end
+
+    # Show specific resource details
+    # @param path [String] API endpoint
+    # @param id [String] Resource UUID
+    # @param params [Hash] Params to be send as querystring
+    # @return [Hash] Resource details
+    # @raise [RequestError] If response code is different than 2XX
+    def detail(path, id, params: nil)
+      params = {} if params.nil?
+
+      resource_path = format('%<path>s%<id>s/', path: path, id: id)
+      response = get(resource_path, params)
+
+      raise_for_status response
+      response.body
+    end
+
+    # Perform a POST request to an API endpoint
+    # @param path [String] API endpoint
+    # @param data [object] JSON parseable object
+    # @return [Hash] Response details
+    # @raise [RequestError] If response code is different than 2XX
+    def post(path, data)
+      response = @session.post(path, data.to_json)
+      raise_for_status response
+      response.body
+    end
+
+    # Perform a PUT request to an specific resource
+    # @param path [String] API endpoint
+    # @param id [String] Resource UUID
+    # @param data [object] JSON parseable object
+    # @return [Hash] Response details
+    # @raise [RequestError] If response code is different than 2XX
+    def put(path, id, data)
+      url = format('%<path>s%<id>s/', path: path, id: id)
+      response = @session.put(url, data.to_json)
+      raise_for_status response
+      response.body
+    end
+
+    # Perform a PATCH request to an API endpoint
+    # @param path [String] API endpoint
+    # @param data [object] JSON parseable object
+    # @return [Hash] Response details
+    # @raise [RequestError] If response code is different than 2XX
+    def patch(path, data)
+      response = @session.patch(path, data.to_json)
+      raise_for_status response
+      response.body
+    end
+
+    # Delete existing resource
+    # @param path [String] API endpoint
+    # @param id [String] Resource UUID
+    # @return [Boolean] true if resource is successfully deleted else false
+    def delete(path, id)
+      resource_path = format('%<path>s%<id>s/', path: path, id: id)
+      response = @session.delete(resource_path)
+      response.success?
+    end
+  end
+end

data/lib/belvo/options.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'faraday/options'
+
+module Belvo
+  # @!class LinkOptions < Faraday::Options
+  # Contains the configurable properties for a Link
+  # @!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
+  class LinkOptions < Faraday::Options.new(
+    :access_mode,
+    :token,
+    :encryption_key
+  )
+  end
+
+  # @!class AccountOptions < Faraday::Options
+  # Contains the configurable properties for an Account
+  # @!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
+  class AccountOptions < Faraday::Options.new(
+    :save_data,
+    :token,
+    :encryption_key
+  )
+  end
+
+  # @!class TransactionOptions < Faraday::Options
+  # Contains configurable properties for a Transaction
+  # @!attribute date_to [rw] Date string (YYYY-MM-DD)
+  # @!attribute account [rw] Account ID (UUID)
+  # @!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
+  class TransactionOptions < Faraday::Options.new(
+    :date_to,
+    :account,
+    :token,
+    :encryption_key,
+    :save_data
+  )
+  end
+
+  # @!class OwnerOptions < Faraday::Options
+  # Contains configurable properties of an Owner
+  # @!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
+  class OwnerOptions < Faraday::Options.new(:token, :encryption_key, :save_data)
+  end
+
+  # @!class BalanceOptions < Faraday::Options
+  # Contains configurable properties of a Balance
+  # @!attribute date_to [rw] Date string (YYYY-MM-DD)
+  # @!attribute account [rw] Account ID (UUID)
+  # @!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
+  class BalanceOptions < Faraday::Options.new(
+    :date_to,
+    :account,
+    :token,
+    :encryption_key,
+    :save_data
+  )
+  end
+
+  # @!class StatementOptions < Faraday::Options
+  # Contains configurable properties of a Statement
+  # @!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 StatementOptions < Faraday::Options.new(
+    :token,
+    :encryption_key,
+    :save_data,
+    :attach_pdf
+  )
+  end
+
+  # @!class InvoiceOptions < Faraday::Options
+  # Contains configurable properties of an Invoice
+  # @!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_xml [rw] Should the XML file be included in the
+  #   response or not.
+  class InvoiceOptions < Faraday::Options.new(
+    :save_data,
+    :token,
+    :encryption_key,
+    :attach_xml
+  )
+  end
+
+  # @!class TaxReturnOptions < Faraday::Options
+  # Contains configurable properties of a TaxReturn
+  # @!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 TaxReturnOptions < Faraday::Options.new(
+    :token,
+    :encryption_key,
+    :save_data,
+    :attach_pdf
+  )
+  end
+end

data/lib/belvo/resources.rb

@@ -0,0 +1,334 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'belvo/options'
+
+module Belvo
+  # Represents a consumable REST resource from Belvo API
+  class Resource
+    # Resource API endpoint
+    # @return [String] the API endpoint
+    attr_reader :endpoint
+
+    # @param session [APISession] current Belvo API session
+    def initialize(session)
+      @session = session
+    end
+
+    # Remove nil values from a request body
+    # @param body [Hash] request body
+    # @return [Hash] body without nil values
+    def clean(body:)
+      body.delete_if { |_key, value| value.nil? }
+    end
+
+    # List all results
+    # @return [Array]
+    # @raise [RequestError] If response code is different than 2XX
+    def list
+      results = []
+      @session.list(@endpoint) { |item| results.push item }
+      results
+    end
+
+    # Show specific resource details
+    # @param id [String] Resource UUID
+    # @return [Hash]
+    # @raise [RequestError] If response code is different than 2XX
+    def detail(id:)
+      @session.detail(@endpoint, id)
+    end
+
+    # Delete existing resource
+    # @param id [String] Resource UUID
+    # @return [Boolean] true if resource is successfully deleted else false
+    def delete(id:)
+      @session.delete(@endpoint, id)
+    end
+
+    # Resume data extraction session. Use this method after you have received a
+    #   HTTP 428 response.
+    # @param session_id [String] Session UUID included in the 428 response
+    # @param link [String, nil] Link UUID
+    # @raise [RequestError] If response code is different than 2XX
+    def resume(session_id:, token:, link: nil)
+      data = { session: session_id, token: token, link: link }
+      @session.patch(@endpoint, data)
+    end
+  end
+
+  # A Link is a set of credentials associated to a end-user access
+  class Link < Resource
+    class AccessMode
+      # Use single to do ad hoc one-time requests
+      SINGLE = 'single'
+      # Use recurrent to have Belvo refresh your link data on a daily basis
+      RECURRENT = 'recurrent'
+    end
+
+    def initialize(session)
+      super(session)
+      @endpoint = 'links/'
+    end
+
+    # Register a new link
+    # @param institution [String] Institution name
+    # @param username [String] End-user username
+    # @param password [String] End-user password
+    # @param password2 [String, nil] End-user secondary password, if any
+    # @param options [LinkOptions] Configurable properties
+    # @return [Hash] created link details
+    # @raise [RequestError] If response code is different than 2XX
+    def register(
+      institution:,
+      username:,
+      password:,
+      password2: nil,
+      options: nil
+    )
+      options = LinkOptions.from(options)
+      body = {
+        institution: institution,
+        username: username,
+        password: password,
+        password2: password2,
+        token: options.token,
+        encryption_key: options.encryption_key,
+        access_mode: options.access_mode || AccessMode::SINGLE
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+
+    # Allows to change password, password2 or setting a custom encryption key
+    # @param id [String] Link UUID
+    # @param password [String] End-user password
+    # @param password2 [String, nil] End-user secondary password, if any
+    # @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)
+      options = LinkOptions.from(options)
+      body = {
+        password: password,
+        password2: password2,
+        token: options.token,
+        encryption_key: options.encryption_key
+      }.merge(options)
+      body = clean body: body
+      @session.put(@endpoint, id, body)
+    end
+  end
+
+  # An Account is the representation of a bank account inside a financial
+  # institution.
+  class Account < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'accounts/'
+    end
+
+    # Retrieve accounts from an existing link
+    # @param link [String] Link UUID
+    # @param options [AccountOptions] Configurable properties
+    # @return [Hash] created link details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = AccountOptions.from(options)
+      body = {
+        link: link,
+        token: options.token,
+        encryption_key: options.encryption_key,
+        save_data: options.save_data || true
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+  end
+
+  # A Transaction contains the detailed information of each movement inside an
+  # Account.
+  class Transaction < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'transactions/'
+    end
+
+    # Retrieve transactions from an existing link
+    # @param link [String] Link UUID
+    # @param date_from [String] Date string (YYYY-MM-DD)
+    # @param options [TransactionOptions] Configurable properties
+    # @return [Hash] created link details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, date_from:, options: nil)
+      options = TransactionOptions.from(options)
+      date_to = options.date_to || Date.today.to_s
+      body = {
+        link: link,
+        date_from: date_from,
+        date_to: date_to,
+        token: options.token,
+        account: options.account,
+        encryption_key: options.encryption_key,
+        save_data: options.save_data || true
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+  end
+
+  # An Owner represents the person who has access to a Link and is the owner
+  # of all the Accounts inside the Link
+  class Owner < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'owners/'
+    end
+
+    # Retrieve owners from an existing link
+    # @param link [String] Link UUID
+    # @param options [OwnerOptions] Configurable properties
+    # @return [Hash] created link details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = OwnerOptions.from(options)
+      body = {
+        link: link,
+        token: options.token,
+        encryption_key: options.encryption_key,
+        save_data: options.save_data || true
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+  end
+
+  # A Balance represents the financial status of an Account at a given time.
+  class Balance < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'balances/'
+    end
+
+    # Retrieve balances from a specific account or all accounts from a
+    #   specific link
+    # @param link [String] Link UUID
+    # @param date_from [String] Date string (YYYY-MM-DD)
+    # @param options [BalanceOptions] Configurable properties
+    # @return [Hash] created link details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, date_from:, options: nil)
+      options = BalanceOptions.from(options)
+      date_to = options.date_to || Date.today.to_s
+      body = {
+        link: link,
+        date_from: date_from,
+        date_to: date_to,
+        token: options.token,
+        account: options.account,
+        encryption_key: options.encryption_key,
+        save_data: options.save_data || true
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+  end
+
+  # A Statement contains a resume of monthly Transactions inside an Account.
+  class Statement < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'statements/'
+    end
+
+    # Retrieve statements information from a specific banking link.
+    # @param link [String] Link UUID
+    # @param year [Integer]
+    # @param month [Integer]
+    # @param options [StatementOptions] Configurable properties
+    # @return [Hash] created link details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, account:, year:, month:, options: nil)
+      options = StatementOptions.from(options)
+      body = {
+        link: link,
+        account: account,
+        year: year,
+        month: month,
+        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
+  end
+
+  # An Invoice is the representation of an electronic invoice, that can be
+  # received or sent, by a business or an individual and has been uploaded
+  # to the fiscal institution website
+  class Invoice < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'invoices/'
+    end
+
+    # @param link [String] Link UUID
+    # @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
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, date_from:, date_to:, type:, options: nil)
+      options = InvoiceOptions.from(options)
+      body = {
+        link: link,
+        date_from: date_from,
+        date_to: date_to,
+        type: type,
+        token: options.token,
+        encryption_key: options.encryption_key,
+        save_data: options.save_data || true,
+        attach_xml: options.attach_xml
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    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
+    def initialize(session)
+      super(session)
+      @endpoint = 'tax-returns/'
+    end
+
+    # Retrieve tax returns information from a specific fiscal link.
+    # @param link [String] Link UUID
+    # @param year_from [Integer]
+    # @param year_to [Integer]
+    # @param options [TaxReturnOptions] Configurable properties
+    # @return [Hash] created link details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, year_from:, year_to:, 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
+      }.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
+end

data/lib/belvo/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Belvo
+  # belvo-ruby current version
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: belvo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Belvo Finance S.L.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-08 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  Belvo is the leading Open Banking API platform in Latin
+                         America and the easiest way for users to connect their
+                         account to an app
+email:
+- hello@belvo.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- belvo.gemspec
+- bin/console
+- bin/setup
+- lib/belvo.rb
+- lib/belvo/exceptions.rb
+- lib/belvo/http.rb
+- lib/belvo/options.rb
+- lib/belvo/resources.rb
+- lib/belvo/version.rb
+homepage: https://github.com/belvo-finance/belvo-ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/belvo-finance/belvo-ruby
+  source_code_uri: https://github.com/belvo-finance/belvo-ruby
+  changelog_uri: https://github.com/belvo-finance/belvo-ruby/blob/master/README.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: The Ruby gem for the Belvo API
+test_files: []