[CLN-2115] Armar SDK de transfers en Ruby (#18)

* feature(api): add support for v2 endpoint

* feature(entity): Add entity resource

* feature(entities): Add entities endpoints

* feature(entity): Add refresh method to entity

* feature(entities): Add readme docs for entity

* feature(client): Add post requests

* refactor(movements): Move existing accounts to movements namespace

* refactor(entity): Move entities to Transfers folder

* refactor(clients): Refactor Clients to have separate clients for Movements and Transfers

* refactor(balance): Move balance to Movements namespace

* refactor(institution): Move Institutions to Movements namespace

* refactor(links): Move links to Movements namespace

* refactor(movements): Move movements to Movements namespace

* refactor(transfer-accounts): Move TransferAccounts to Movements namespace

* refactor(fintoc): Restrutcture entire folder structure to have better navigability and more intuitive naming

* refactor(transfers-client): Update spec to mock api response rather than method response

* fix(movements-http-mocks): Move mocks to correct folder (and delete deprecated ones)

* fix(movements): Fix movements comparison

* feature(base-client): Add patch request method

* feature(accounts): Create transfers account resource

* feature(accounts): Add accounts methods to Transfers client

* refactor(client): Add comment to Fintoc::Client to make sure that the AI doesn't use it since it is expected to be deprecated

* refactor(entitities): Remove unnecessary entities array conversion

* feature(accounts): Add refresh method to accounts

* feature(accounts): Add update method for accounts

* refactor(client): Add comment indicating that Client is only kept for backward compatibility

* refactor(accounts): Configure money-rails gem instead of custom formatter

* refactor(resources): Prefer explicit refreshing of resource values

* feature(account-numbers): Add account numbers transfer resource

* feature(account-numbers): Add account numbers methods

* feature(account-number): Add refresh method to account numbers

* feature(account-numbers): Add update method to account numbers

* refactor(resources): Do not refresh using initialize as it returns a different object

* feature(transfers): Add transfers resources

* feature(jws): Add JWS private key to request args for use of transfers create and patch methods

* feature(transfers): Add transfers methods

* feature(transfers): Add refresh method to transfers

* feature(transfer): Add return_transfer method to transfer

* refactor(client/jws): Move jws condition to separate method

* feature(simulate): Implement simulate methods

* feature(account/simulate): Use simulate_receive_transfer as isntance method for Account

* feature(account-number/simulate): Use simulate_receive_transfer as isntance method for AccountNumber

* feature(simulate): Only allow simulating inbound transfers on test mode

* refactor(transfers-methods/spec): Better mocks for unit tests of methods

* feature(account-verifications): Add AccountVerification resource

* feature(account-verifications): Add account verification methods

* feature(account-verifications): add refresh methods to account verifications

* refactor(transfers): Remove unnecessary inclusions of Utils

* refactor(transfer/refresh-resources): Use ArgumentError for resfresh_from_* error on mismatching instances

* refactor(errors): Update errors url ref

* feature(errors): Update list of possible errors

* feature(docs): Update readme docs to include new methods and changes to the api use

* refactor(client): Use managers instead of methods to access all api methods as in Python SDK

* fix(readme): Fix typo

* refactor(client): Prefer having v1/v2 clients instead of movements/transfers/others for consistency with other SDKs

* fix(readme): Fix readme client

* feat: add webhook signature module

* feat: add webhook signature error

* feat: include webhook signature module to fintoc

* refactor(errors): Remove redundant to_s at Errors

Since it is implied by inheriting from StandardError

* refactor(v1/accounts): Move Headers to frozen constant

* fix(v1/link): Fix call to delete

* refactor(fintoc/version): Move version spec to better folder

* feature(spec): Increase spec coverage

* fix(transfers-manager): Fix mock of transfers return in spec

* fix(base-client): Invert visible part and hidden part of key

This also adds a spec for BaseClient

* feature(account/spec): Add missing spec for update_balance method of V1::Account

* feature(spec/link): Add missing spec for update_accounts of V1::Link

* feature(simplecov): Add simplecov gem

* feature(simplecov): Add simplecov config

* feature(ci/simplecov): Add coverage requirement to CI

* feature(version): Bump version to 1.0.0 and update changelog

---------

Co-authored-by: Danny Fuentes <dannyfuf@gmail.com>

Author: pibahamondesw

.github/workflows/ci.yml

@@ -43,4 +43,4 @@ jobs:
         bundler-cache: true
 
     - name: Run tests
-      run: bundle exec rspec
+      run: COVERAGE=true bundle exec rspec

CHANGELOG.md

@@ -1,12 +1,45 @@
 # Changelog
 
-## 0.2.0 - 2025-08-26
+## 1.0.0 - 2025-09-05
 
-* Update linting rules and fix linting issues
-* Update CI flow
-* Update gems and support only Ruby versions that haven't reached EOL
-* Update README
+### 🚀 New Features
+
+- **New Client Architecture**: Restructured client to distinguish between API versions
+  - Movements API now accessible via `Fintoc::V1::Client`
+  - Transfers API accessible via `Fintoc::V2::Client`
+  - Unified client interface with `Fintoc::Client` providing access to both versions
+  - Backward compatibility maintained for existing method signatures
+
+- **V2 Client - Transfers API Implementation**: Partial implementation of Transfers API endpoints in `Fintoc::V2::Client`
+  - **Entities**: List and retrieve business entities
+  - **Transfer Accounts**: Create, read, update, and list transfer accounts
+  - **Account Numbers**: Manage account numbers/CLABEs
+  - **Transfers**: Create, retrieve, list, and return transfers
+  - **Simulation**: Simulate receiving transfers for testing
+  - **Account Verifications**: Verify account numbers
+  - **Movements**: TODO! Not yet implemented
+
+### 🧪 Testing & Quality
+
+- **100% Line Coverage**: Achieved full line coverage using SimpleCov gem, increasing the spec coverage and testing all new code.
+  - Configured with `minimum_coverage 100` and `minimum_coverage_by_file 100`
+  - Uses `simplecov_text_formatter` and `simplecov_linter_formatter` for reporting
+
+- **Robust CI Pipeline**: Enhanced GitHub Actions workflow for comprehensive testing
+  - **Linting**: Dedicated RuboCop job for code quality enforcement
+  - **Multi-version Testing**: Tests against all currently supported Ruby versions (3.2, 3.3, and 3.4) for version compatibility
+  - **Coverage Integration**: Automated coverage reporting in CI pipeline
+
+### Others
+
+- **Money-Rails Integration**: Added `money-rails` gem for proper currency handling
+- **Comprehensive README Update**: Extensively updated documentation with usage examples and development instructions
+- **Improved Error Handling**: Better error management across API versions
+- **JWS Support**: JSON Web Signature support for secure V2 API operations
+- **HMac Signature verification**: Added the `Fintoc::WebhookSignature` class for easing webhook signature verification
 
 ## 0.1.0 - 2021-01-18
 
+Initial version
+
 * Up to date with the [2020-11-17](https://docs.fintoc.com/docs/api-changelog#2020-11-17) API version

Gemfile

@@ -4,12 +4,20 @@ source 'https://rubygems.org'
 gemspec
 
 # Development dependencies
-gem 'rexml'  # Required for webmock in Ruby 3.0+
-gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 1.80'
-gem 'rubocop-capybara', '~> 2.22', '>= 2.22.1'
-gem 'rubocop-performance', '~> 1.25'
-gem 'rubocop-rails', '~> 2.33', '>= 2.33.3'
-gem 'rubocop-rspec', '~> 3.6'
-gem 'vcr', '~> 6.3'
-gem 'webmock'
+group :development do
+  gem 'rubocop', '~> 1.80'
+  gem 'rubocop-capybara', '~> 2.22', '>= 2.22.1'
+  gem 'rubocop-performance', '~> 1.25'
+  gem 'rubocop-rails', '~> 2.33', '>= 2.33.3'
+  gem 'rubocop-rspec', '~> 3.6'
+end
+
+group :test do
+  gem 'rexml'  # Required for webmock in Ruby 3.0+
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov', '~> 0.21'
+  gem 'simplecov_linter_formatter'
+  gem 'simplecov_text_formatter'
+  gem 'vcr', '~> 6.3'
+  gem 'webmock'
+end

Gemfile.lock

@@ -1,13 +1,30 @@
 PATH
   remote: .
   specs:
-    fintoc (0.2.0)
+    fintoc (1.0.0)
       http
+      money-rails
       tabulate
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (8.0.2.1)
+      actionview (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.0.2.1)
+      activesupport (= 8.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
     activesupport (8.0.2.1)
       base64
       benchmark (>= 0.3)
@@ -27,22 +44,26 @@ GEM
     base64 (0.3.0)
     benchmark (0.4.1)
     bigdecimal (3.2.2)
+    builder (3.3.0)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.3)
     crack (1.0.0)
       bigdecimal
       rexml
+    crass (1.0.6)
+    date (3.4.1)
     diff-lcs (1.6.2)
+    docile (1.4.1)
     domain_name (0.6.20240107)
     drb (2.2.3)
+    erb (5.0.2)
+    erubi (1.13.1)
     ffi (1.17.2)
     ffi (1.17.2-aarch64-linux-gnu)
     ffi (1.17.2-aarch64-linux-musl)
     ffi (1.17.2-arm-linux-gnu)
     ffi (1.17.2-arm-linux-musl)
     ffi (1.17.2-arm64-darwin)
-    ffi (1.17.2-x86-linux-gnu)
-    ffi (1.17.2-x86-linux-musl)
     ffi (1.17.2-x86_64-darwin)
     ffi (1.17.2-x86_64-linux-gnu)
     ffi (1.17.2-x86_64-linux-musl)
@@ -60,25 +81,91 @@ GEM
     http-form_data (2.3.0)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
+    io-console (0.8.1)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     json (2.13.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     llhttp-ffi (0.5.1)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
     logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
     minitest (5.25.5)
+    monetize (1.13.0)
+      money (~> 6.12)
+    money (6.19.0)
+      i18n (>= 0.6.4, <= 2)
+    money-rails (1.15.0)
+      activesupport (>= 3.0)
+      monetize (~> 1.9)
+      money (~> 6.13)
+      railties (>= 3.0)
+    nokogiri (1.18.9-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.9-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.9-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.9-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.9-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.9-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.9-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.9-x86_64-linux-musl)
+      racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
     prism (1.4.0)
+    psych (5.2.6)
+      date
+      stringio
     public_suffix (6.0.2)
     racc (1.8.1)
     rack (3.2.0)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.3.0)
+    rdoc (6.14.2)
+      erb
+      psych (>= 4.0.0)
     regexp_parser (2.11.2)
+    reline (0.6.2)
+      io-console (~> 0.5)
     rexml (3.4.2)
     rspec (3.13.1)
       rspec-core (~> 3.13.0)
@@ -125,29 +212,39 @@ GEM
       rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    simplecov_linter_formatter (0.2.0)
+      rainbow
+    simplecov_text_formatter (0.1.0)
+    stringio (3.1.7)
     tabulate (0.1.2)
+    thor (1.4.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.1.5)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
     uri (1.0.3)
+    useragent (0.16.11)
     vcr (6.3.1)
       base64
     webmock (3.25.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   aarch64-linux-gnu
   aarch64-linux-musl
   arm-linux-gnu
   arm-linux-musl
   arm64-darwin
-  ruby
-  x86-linux-gnu
-  x86-linux-musl
   x86_64-darwin
   x86_64-linux
   x86_64-linux-gnu
@@ -162,6 +259,9 @@ DEPENDENCIES
   rubocop-performance (~> 1.25)
   rubocop-rails (~> 2.33, >= 2.33.3)
   rubocop-rspec (~> 3.6)
+  simplecov (~> 0.21)
+  simplecov_linter_formatter
+  simplecov_text_formatter
   vcr (~> 6.3)
   webmock