bridgeapi_client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2747f2ce696db93a077c23a3b1ca5e50230c019989f215207847fdffe7b06d8d
+  data.tar.gz: 7ed8c29547e5291d66928c10949507affb204b12109ca3ba9f0cec0442f9d2be
+SHA512:
+  metadata.gz: 117136501562fc77f7edc69f3e696853a429d1bbfed384e97c6b805e60933a1a89e88e2ab9d58a277ce48896959b17c36cb3b22d6ebf2c58765da907d3151235
+  data.tar.gz: e0bcc3cadc614398200961a7885c7b829866853088ddc86ea725c3586147be4b12e5d05ddb20779ef3dc32d89ca8f6b2cb2882d3a30fdf91701726eb5007b794

data/.env.example

@@ -0,0 +1,2 @@
+BRIDGE_API_CLIENT_ID=
+BRIDGE_API_CLIENT_SECRET=

data/.github/workflows/ci-analysis.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3.4
+      - name: Run the default task
+        run: |
+          gem install bundler
+          bundle install
+          bundle exec rspec

data/.github/workflows/rubocop-analysis.yml

@@ -0,0 +1,24 @@
+# .github/workflows/rubocop-analysis.yml
+name: "RuboCop"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  rubocop:
+    name: Guidelines checks
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.3.4
+        bundler-cache: true

data/.gitignore

@@ -0,0 +1,11 @@
+.env
+.rspec_status
+/_yardoc/
+/.bundle/
+/.yardoc
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,50 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 25
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/MultipleDescribes:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## [1.0.1] - 2026-02-07
+
+### Changed
+- Renamed gem from `bridge_api` to `bridgeapi_client` (name conflict on RubyGems)
+
+### Added
+- `debug` configuration option to toggle verbose HTTP request/response logging (default: `false`)
+
+## [1.0.0] - 2026-02-07
+
+### Changed
+- Renamed gem from `bridge_bankin` to `bridge_api`
+- Renamed module from `BridgeBankin` to `BridgeApi`
+- Full compatibility with Bridge API v3 (2025-01-15)
+
+### Fixed
+- Thread safety: API client now uses `Thread.current` storage
+- Pagination: fixed order of appended data in `handle_paging`
+- Authentication: `generate_token` supports `external_user_id` (v3)
+
+### Removed
+- Deprecated v2 methods kept only for backward compatibility warnings

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "awesome_print"
+gem "pry"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "shoulda-matchers"
+gem "vcr"
+gem "webmock"
+
+# Specify your gem's dependencies in sisense.gemspec
+gemspec
+
+gem "bigdecimal", "~> 3.3"
+
+gem "base64", "~> 0.3.0"

data/Gemfile.lock

@@ -0,0 +1,186 @@
+PATH
+  remote: .
+  specs:
+    bridgeapi_client (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (8.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    awesome_print (1.9.2)
+    base64 (0.3.0)
+    bigdecimal (3.3.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
+    crack (1.0.1)
+      bigdecimal
+      rexml
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    hashdiff (1.2.1)
+    i18n (1.14.8)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.2)
+    json (2.18.1)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    method_source (1.1.0)
+    minitest (6.0.1)
+      prism (~> 1.5)
+    parallel (1.27.0)
+    parser (3.3.10.1)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    pry (0.16.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      reline (>= 0.6.0)
+    public_suffix (7.0.2)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rexml (3.4.4)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.84.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    shoulda-matchers (7.0.1)
+      activesupport (>= 7.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    vcr (6.4.0)
+    webmock (3.26.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-25
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  base64 (~> 0.3.0)
+  bigdecimal (~> 3.3)
+  bridgeapi_client!
+  pry
+  rake
+  rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+  shoulda-matchers
+  vcr
+  webmock
+
+CHECKSUMS
+  activesupport (8.1.2) sha256=88842578ccd0d40f658289b0e8c842acfe9af751afee2e0744a7873f50b6fdae
+  addressable (2.8.8) sha256=7c13b8f9536cf6364c03b9d417c19986019e28f7c00ac8132da4eb0fe393b057
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  awesome_print (1.9.2) sha256=e99b32b704acff16d768b3468680793ced40bfdc4537eb07e06a4be11133786e
+  base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b
+  bigdecimal (3.3.1) sha256=eaa01e228be54c4f9f53bf3cc34fe3d5e845c31963e7fcc5bedb05a4e7d52218
+  bridgeapi_client (1.0.1)
+  coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
+  concurrent-ruby (1.3.6) sha256=6b56837e1e7e5292f9864f34b69c5a2cbc75c0cf5338f1ce9903d10fa762d5ab
+  connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a
+  crack (1.0.1) sha256=ff4a10390cd31d66440b7524eb1841874db86201d5b70032028553130b6d4c7e
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
+  hashdiff (1.2.1) sha256=9c079dbc513dfc8833ab59c0c2d8f230fa28499cc5efb4b8dd276cf931457cd1
+  i18n (1.14.8) sha256=285778639134865c5e0f6269e0b818256017e8cde89993fdfcbfb64d088824a5
+  io-console (0.8.2) sha256=d6e3ae7a7cc7574f4b8893b4fca2162e57a825b223a177b7afa236c5ef9814cc
+  json (2.18.1) sha256=fe112755501b8d0466b5ada6cf50c8c3f41e897fa128ac5d263ec09eedc9f986
+  language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
+  lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  method_source (1.1.0) sha256=181301c9c45b731b4769bc81e8860e72f9161ad7d66dd99103c9ab84f560f5c5
+  minitest (6.0.1) sha256=7854c74f48e2e975969062833adc4013f249a4b212f5e7b9d5c040bf838d54bb
+  parallel (1.27.0) sha256=4ac151e1806b755fb4e2dc2332cbf0e54f2e24ba821ff2d3dcf86bf6dc4ae130
+  parser (3.3.10.1) sha256=06f6a725d2cd91e5e7f2b7c32ba143631e1f7c8ae2fb918fc4cebec187e6a688
+  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
+  pry (0.16.0) sha256=d76c69065698ed1f85e717bd33d7942c38a50868f6b0673c636192b3d1b6054e
+  public_suffix (7.0.2) sha256=9114090c8e4e7135c1fd0e7acfea33afaab38101884320c65aaa0ffb8e26a857
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c
+  regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
+  reline (0.6.3) sha256=1198b04973565b36ec0f11542ab3f5cfeeec34823f4e54cebde90968092b1835
+  rexml (3.4.4) sha256=19e0a2c3425dfbf2d4fc1189747bdb2f849b6c5e74180401b15734bc97b5d142
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-mocks (3.13.7) sha256=0979034e64b1d7a838aaaddf12bf065ea4dc40ef3d4c39f01f93ae2c66c62b1c
+  rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
+  rubocop (1.84.1) sha256=14cc626f355141f5a2ef53c10a68d66b13bb30639b26370a76559096cc6bcc1a
+  rubocop-ast (1.49.0) sha256=49c3676d3123a0923d333e20c6c2dbaaae2d2287b475273fddee0c61da9f71fd
+  rubocop-rake (0.7.1) sha256=3797f2b6810c3e9df7376c26d5f44f3475eda59eb1adc38e6f62ecf027cbae4d
+  rubocop-rspec (3.9.0) sha256=8fa70a3619408237d789aeecfb9beef40576acc855173e60939d63332fdb55e2
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
+  shoulda-matchers (7.0.1) sha256=b4bfd8744c10e0a36c8ac1a687f921ee7e25ed529e50488d61b79a8688749c77
+  tzinfo (2.0.6) sha256=8daf828cc77bcf7d63b0e3bdb6caa47e2272dcfaf4fbfe46f8c3a9df087a829b
+  unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
+  unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
+  uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6
+  vcr (6.4.0) sha256=077ac92cc16efc5904eb90492a18153b5e6ca5398046d8a249a7c96a9ea24ae6
+  webmock (3.26.1) sha256=4f696fb57c90a827c20aadb2d4f9058bbff10f7f043bd0d4c3f58791143b1cd7
+
+BUNDLED WITH
+  4.0.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Neatops
+
+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,229 @@
+<p align="center">
+  <img width="500" src="https://user-images.githubusercontent.com/112219/103307983-5fe04500-49df-11eb-9618-1f9704b2f460.png" alt="Bankin Bridge Logo">
+</p>
+
+<p align="center">
+  <a href="https://badge.fury.io/rb/bridge_api">
+    <img src="https://badge.fury.io/rb/bridge_api.svg" alt="Gem Version">
+  </a>
+  <a href="https://github.com/neatops/bridge_api/actions?query=workflow%3ACI">
+    <img src="https://github.com/neatops/bridge_api/workflows/CI/badge.svg" alt="CI Status">
+  </a>
+  <a href="https://github.com/neatops/bridge_api/actions?query=workflow%3ARuboCop">
+    <img src="https://github.com/neatops/bridge_api/workflows/RuboCop/badge.svg" alt="Rubocop Status">
+  </a>
+  <a href="https://rubydoc.info/github/neatops/bridge_api/main">
+    <img src="https://img.shields.io/badge/yard-docs-blue.svg" alt="RubyDoc Link">
+  </a>
+</p>
+
+<br />
+
+This gem is an **unofficial Ruby client** that consumes the [Bridge by Bankin’ API](https://bridgeapi.io/).
+
+Thanks to a safe and automated access to bank data, Bridge powered by Bankin’ provides
+competitive and smart solutions to build conversion-driver financial services.
+
+You'll find more information about Bridge API in the [official documentations](https://docs.bridgeapi.io/).
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'bridge_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bridge_api
+
+## Usage
+
+### Requirements
+
+To begin using the API with this gem, you need to create an account to the dashboard on the [Bridge website](https://dashboard.bridgeapi.io/signup).
+Then you’ll have to create a new `application` and generate the required API credentials: a `client_id` and `client_secret`.
+You can find more information about this process by visiting the [Bridge API Dashboard documentation](https://docs.bridgeapi.io/docs/dashboard).
+
+### Getting started
+
+One you have your valid API credential you can now create an initializer in your app like this:
+
+```ruby
+BridgeApi.configure do |config|
+  config.api_client_id = ENV["BRIDGE_API_CLIENT_ID"]
+  config.api_client_secret = ENV["BRIDGE_API_CLIENT_SECRET"]
+  config.follow_pages = true
+end
+```
+
+Feel free to replace those environment variables by whatever values that work for you.
+
+Some resources are public (banks and categories) meaning that only provided the `client_id` and `client_secret` are required.
+Here is an example on how you can use this gem to fetch the banks:
+
+```ruby
+BridgeApi::Bank.list
+=> [#<BridgeApi::BridgeObject:0x00007fbb0727c620
+  @country_code="DE",
+  @parent_banks=
+   [#<BridgeApi::BridgeObject:0x00007fbb0727c148
+     @banks=
+      [#<BridgeApi::Bank:0x00007fbad702f6b8
+        @authentication_type="INTERNAL_CREDS",
+        @automatic_refresh=true,
+        @capabilities=["ais"],
+        @country_code="DE",
+        @deeplink_android=nil,
+        @deeplink_ios=nil,
+        @form=[#<BridgeApi::BridgeObject:0x00007fbad702cf30 @isNum="0", @label="Email", @maxLength=nil, @type="USER">, #<BridgeApi::BridgeObject:0x00007fbad702c648 @isNum="0", @label="Password", @maxLength=nil, @type="PWD">],
+        @id=457,
+        @logo_url="https://web.bankin.com/img/banks-logo/neo/04N26@2x.png",
+        @name="N26 (Number 26) DE",
+        @payment_enabled=false,
+        @primary_color=nil,
+        @secondary_color=nil,
+        @transfer_enabled=false>],
+     @display_order=0,
+     @is_highlighted=false,
+     @logo_url="https://web.bankin.com/img/banks-logo/neo/04N26@2x.png",
+     @name="N26 (Number 26) DE">,
+     ...]
+   ...]
+ ...]
+```
+
+But the majority of the resources need a logged in user. Here is how to create one using the gem:
+
+```ruby
+BridgeApi::User.create(email: "john.doe@email.com", password: "password123!")
+=> #<BridgeApi::User:0x00007fbb07c5e990 @email="john.doe@email.com", @uuid="f974389d-1442-48bb-bb5e-ac62d1a96984">
+```
+
+Then you can generate an `access_token` for this user by using the `Authorization` class:
+
+```ruby
+BridgeApi::Authorization.generate_token(email: "john.doe@email.com", password: "password123!")
+=> #<BridgeApi::Authorization:0x00007fbb07967f48 @access_token="58b0195d943f9a3e8433cda7dea48a70339eafc6-5fe7c375-873b-4b0d-bcff-4541c1e19488", @expires_at=2020-12-29 21:35:28.97 UTC>
+```
+
+Since the majority of endpoints are private, you’ll need to pass a valid `access_token` each time you request them.
+Here is how it works with the user we previously created:
+
+```ruby
+BridgeApi::Transaction.list(access_token: auth.access_token)
+=> [#<BridgeApi::Transaction:0x00007fbb0002d948
+  @account=#<BridgeApi::Account:0x00007fbb0002c250 @id=22271302>,
+  @amount=-676.0,
+  @category=#<BridgeApi::Category:0x00007fbb0002c520 @id=79>,
+  @currency_code="EUR",
+  @date=#<Date: 2021-01-02 ((2459217j,0s,0n),+0s,2299161j)>,
+  @description="Achat De Titres",
+  @id=38000214608599,
+  @is_deleted=false,
+  @is_future=true,
+  @raw_description="ACHAT DE TITRES - 020121",
+  @show_client_side=true,
+  @updated_at=2020-12-29 19:40:50.942 UTC>,
+ #<BridgeApi::Transaction:0x00007fbb00023da8
+  @account=#<BridgeApi::Account:0x00007fbb000229f8 @id=22271298>,
+  @amount=170.0,
+  @category=#<BridgeApi::Category:0x00007fbb00022c50 @id=289>,
+  @currency_code="EUR",
+  @date=#<Date: 2021-01-02 ((2459217j,0s,0n),+0s,2299161j)>,
+  @description="Economies",
+  @id=38000214608462,
+  @is_deleted=false,
+  @is_future=true,
+  @raw_description="Economies - 020121",
+  @show_client_side=true,
+  @updated_at=2020-12-29 19:40:49.564 UTC>,
+  ...
+]
+```
+
+If you need more information on how the API works or which parameters you can use for a specific query, we really encourage you to consult the great [official guides](https://docs.bridgeapi.io/docs).
+
+### Parameters
+
+##### Mandatory parameters
+
+In some case you'll need to specify some parameters to complete your request.
+For instance, in order to retrieve a specific `user`, it requires you to pass the user's `UUID`:
+
+```ruby
+BridgeApi::User.find(uuid: "f974389d-1442-48bb-bb5e-ac62d1a96984")
+=> #<BridgeApi::User:0x00007fbb07febf90 @email="john.doe@email.com", @uuid="f974389d-1442-48bb-bb5e-ac62d1a96984">
+```
+
+Note that in some case, the API uses basic sequential `IDs` instead of `UUIDs`. In that case just replace `uuid` key by `id`:
+
+```ruby
+BridgeApi::Bank.find(id: 457)
+=> #<BridgeApi::Bank:0x00007fbb07ec64d0
+ @authentication_type="INTERNAL_CREDS",
+ @automatic_refresh=true,
+ @capabilities=["ais"],
+ @country_code="DE",
+ @deeplink_android=nil,
+ @deeplink_ios=nil,
+ @form=[#<BridgeApi::BridgeObject:0x00007fbb07ec5968 @isNum="0", @label="Email", @maxLength=nil, @type="USER">, #<BridgeApi::BridgeObject:0x00007fbb07ec54b8 @isNum="0", @label="Password", @maxLength=nil, @type="PWD">],
+ @id=457,
+ @logo_url="https://web.bankin.com/img/banks-logo/neo/04N26@2x.png",
+ @name="N26 (Number 26) DE",
+ @payment_enabled=false,
+ @primary_color=nil,
+ @secondary_color=nil,
+ @transfer_enabled=false>
+```
+
+##### Optional parameters
+
+The gem resources also allows you to pass any optional parameters supported by the API (see [Official Documentation](https://docs.bridgeapi.io/docs/overview)).
+To do so, just pass them as `named parameters` in corresponding resource class method:
+
+```ruby
+BridgeApi::Bank.list(limit: 1)
+=> [#<BridgeApi::BridgeObject:0x00007fbb07b4c228
+  @country_code="FR",
+  @parent_banks=
+   [#<BridgeApi::BridgeObject:0x00007fbb07b4c070
+     @banks=
+      [#<BridgeApi::Bank:0x00007fbb07b27d38
+        @authentication_type="INTERNAL_CREDS",
+        @automatic_refresh=true,
+        @capabilities=["ais"],
+        @country_code="FR",
+        @deeplink_android=nil,
+        @deeplink_ios=nil,
+        @form=[#<BridgeApi::BridgeObject:0x00007fbb07b271a8 @isNum="1", @label="Identifiant", @maxLength=nil, @type="USER">, #<BridgeApi::BridgeObject:0x00007fbb07b26cd0 @isNum="0", @label="Mot de passe", @maxLength=nil, @type="PWD">],
+        @id=486,
+        @logo_url="https://web.bankin.com/img/banks-logo/france/themis.png",
+        @name="Themis Banque",
+        @payment_enabled=false,
+        @primary_color=nil,
+        @secondary_color=nil,
+        @transfer_enabled=false>],
+     @display_order=0,
+     @is_highlighted=false,
+     @logo_url="https://web.bankin.com/img/banks-logo/france/themis.png",
+     @name="Themis Banque">]>]
+```
+
+## Development
+
+If you need more detailed informations regarding the gem source code you can find more in the official [RubyDoc](https://rubydoc.info/github/neatops/bridge_api/main).
+
+## Contributing
+
+We're convinced this gem could be improved a lot or simply not cover every needs you have. That's why contributions of any kind is very encouraged.
+Bug reports and pull requests are welcome on GitHub at https://github.com/neatops/bridge_api. This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]