bridge_bankin 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe54b48509650b463422657a08f719b65ddbdd67f02c51acfb02cde720cf795
-  data.tar.gz: 789e29bc5b5f95a3a9dac2954c17c95a5a5420cff9fffd45e46d4dde85bfa0ad
+  metadata.gz: 6ddf1d83e8ae1b1ced919dcc5858be9b8b331f25af05ff26824a462b36f6b240
+  data.tar.gz: 22c5bc8aa682d00956bc0f1bfe8c4c710f18626dfbc770ce01cee890603061d5
 SHA512:
-  metadata.gz: 8808c5e9381f0b3c79cab3c93663561e1f4e8688c172b752a39e02885694b910f669a026822f134d2e9c741400e31438af592e2481b794fe044f9c312ca3d9b4
-  data.tar.gz: 129b232bd2b76a61616deec2f430d1d3b59c3523f4cf802d36bf0ac142548124f40a648fb53f7f2b69e549cd629f6bfec196a478e5a6aa362432fcf94e310c3f
+  metadata.gz: b508b5d4c8d3572bd1db5f85282d9b6da7ca7c1a66b84a7acb5eecff2d94ec5d02791ac7421358085acd615aa65e8d65237a6d9ce603673121c0f3090c9705c8
+  data.tar.gz: fc7df99b3ea68557a473c27d5fd4f6404a3a2cab97cd4ff05cf613f759e8f843d94e9f0fc46213fd7030af231e3380bf11a9e4d06eb7e78dd8c282868c84540f

data/.github/workflows/{main.yml → ci-analysis.yml}

@@ -1,4 +1,4 @@
-name: Ruby
+name: CI
 
 on:
   push:
@@ -16,9 +16,9 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7.2
+          ruby-version: 2.7
       - name: Run the default task
         run: |
-          gem install bundler -v 2.2.1
+          gem install bundler
           bundle install
-          bundle exec rake
+          bundle exec rspec

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

@@ -0,0 +1,44 @@
+# .github/workflows/rubocop-analysis.yml
+name: "RuboCop"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+
+      # This step is not necessary if you add the gem to your Gemfile
+      - name: Install Code Scanning integration
+        run: bundle add code-scanning-rubocop --skip-install
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: RuboCop run
+        run: |
+          bash -c "
+            bundle exec rubocop --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif
+            [[ $? -ne 2 ]]
+          "
+
+      - name: Upload Sarif output
+        uses: github/codeql-action/upload-sarif@v1
+        with:
+          sarif_file: rubocop.sarif

data/.gitignore

@@ -1,13 +1,10 @@
+.env
+.rspec_status
+/_yardoc/
 /.bundle/
 /.yardoc
-/_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status
-
-.env

data/.rubocop.yml

@@ -17,9 +17,6 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 120
 
-Style/Documentation:
-  Enabled: false
-
 Metrics/BlockLength:
   Enabled: false
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bridge_bankin (0.1.0)
+    bridge_bankin (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Olivier Buffon
+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

data/README.md

@@ -1,12 +1,19 @@
-# BridgeBankin
+<p align="center">
+  <img width="500" src="https://user-images.githubusercontent.com/112219/103307983-5fe04500-49df-11eb-9618-1f9704b2f460.png">
+</p>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bridge_bankin`. To experiment with that code, run `bin/console` for an interactive prompt.
+<br />
 
-TODO: Delete this and the text above, and describe your gem
+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:
+Add this line to your application’s Gemfile:
 
 ```ruby
 gem 'bridge_bankin'
@@ -22,22 +29,185 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Requirements
 
-## Development
+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
+BridgeBankin.configure do |config|
+  config.api_client_id = ENV["BRIDGE_API_CLIENT_ID"]
+  config.api_client_secret = ENV["BRIDGE_API_CLIENT_SECRET"]
+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
+BridgeBankin::Bank.list
+=> [#<BridgeBankin::BridgeObject:0x00007fbb0727c620
+  @country_code="DE",
+  @parent_banks=
+   [#<BridgeBankin::BridgeObject:0x00007fbb0727c148
+     @banks=
+      [#<BridgeBankin::Bank:0x00007fbad702f6b8
+        @authentication_type="INTERNAL_CREDS",
+        @automatic_refresh=true,
+        @capabilities=["ais"],
+        @country_code="DE",
+        @deeplink_android=nil,
+        @deeplink_ios=nil,
+        @form=[#<BridgeBankin::BridgeObject:0x00007fbad702cf30 @isNum="0", @label="Email", @maxLength=nil, @type="USER">, #<BridgeBankin::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
+BridgeBankin::User.create(email: "john.doe@email.com", password: "password123!")
+=> #<BridgeBankin::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
+BridgeBankin::Authorization.generate_token(email: "john.doe@email.com", password: "password123!")
+=> #<BridgeBankin::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:
 
-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.
+```ruby
+BridgeBankin::Transaction.list(access_token: auth.access_token)
+=> [#<BridgeBankin::Transaction:0x00007fbb0002d948
+  @account=#<BridgeBankin::Account:0x00007fbb0002c250 @id=22271302>,
+  @amount=-676.0,
+  @category=#<BridgeBankin::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>,
+ #<BridgeBankin::Transaction:0x00007fbb00023da8
+  @account=#<BridgeBankin::Account:0x00007fbb000229f8 @id=22271298>,
+  @amount=170.0,
+  @category=#<BridgeBankin::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
+BridgeBankin::User.find(uuid: "f974389d-1442-48bb-bb5e-ac62d1a96984")
+=> #<BridgeBankin::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
+BridgeBankin::Bank.find(id: 457)
+=> #<BridgeBankin::Bank:0x00007fbb07ec64d0
+ @authentication_type="INTERNAL_CREDS",
+ @automatic_refresh=true,
+ @capabilities=["ais"],
+ @country_code="DE",
+ @deeplink_android=nil,
+ @deeplink_ios=nil,
+ @form=[#<BridgeBankin::BridgeObject:0x00007fbb07ec5968 @isNum="0", @label="Email", @maxLength=nil, @type="USER">, #<BridgeBankin::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
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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
+BridgeBankin::Bank.list(limit: 1)
+=> [#<BridgeBankin::BridgeObject:0x00007fbb07b4c228
+  @country_code="FR",
+  @parent_banks=
+   [#<BridgeBankin::BridgeObject:0x00007fbb07b4c070
+     @banks=
+      [#<BridgeBankin::Bank:0x00007fbb07b27d38
+        @authentication_type="INTERNAL_CREDS",
+        @automatic_refresh=true,
+        @capabilities=["ais"],
+        @country_code="FR",
+        @deeplink_android=nil,
+        @deeplink_ios=nil,
+        @form=[#<BridgeBankin::BridgeObject:0x00007fbb07b271a8 @isNum="1", @label="Identifiant", @maxLength=nil, @type="USER">, #<BridgeBankin::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_bankin/main).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bridge_bankin. 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/[USERNAME]/bridge_bankin/blob/master/CODE_OF_CONDUCT.md).
+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_bankin. 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).
-
-## Code of Conduct
-
-Everyone interacting in the BridgeBankin project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bridge_bankin/blob/master/CODE_OF_CONDUCT.md).

data/bridge_bankin.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Olivier Buffon"]
   spec.email         = ["olivier@buffon.dev"]
 
-  spec.summary       = "Unofficial client to consume Bridge by Bankin’ API"
+  spec.summary       = "Unofficial Ruby client to consume Bridge by Bankin’ API"
 
   spec.description   = "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."

data/lib/bridge_bankin.rb

@@ -15,5 +15,8 @@ require "bridge_bankin/object_types"
 # Resources
 require "bridge_bankin/resources"
 
+#
+# BridgeBankin main module
+#
 module BridgeBankin
 end

data/lib/bridge_bankin/account.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Account resource
+  #
   class Account < BridgeObject
     RESOURCE_TYPE = "account"
 
     class << self
       include API::Resource
 
+      #
+      # List all logged in user accounts
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Account>] the user accounts
+      #
       def list(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/accounts", params)
@@ -14,6 +25,15 @@ module BridgeBankin
         end
       end
 
+      #
+      # Retrieve a single account for logged in user
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Account] the user accounts
+      #
       def find(id:, access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/accounts/#{id}", params)

data/lib/bridge_bankin/api/client.rb

@@ -8,6 +8,9 @@ require "bridge_bankin/api/error"
 
 module BridgeBankin
   module API
+    #
+    # Allows to request the Bridge API using Ruby native net/http library
+    #
     class Client
       HTTP_VERBS_MAP = {
         get: Net::HTTP::Get,
@@ -18,18 +21,56 @@ module BridgeBankin
 
       attr_accessor :access_token
 
+      #
+      # Handles a GET request
+      #
+      # @param [String] path the API endpoint PATH to query
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Hash] the parsed API response
+      #
+      # @raise [API::Error] expectation if API responding with any error
+      #
       def get(path, **params)
         request :get, path, params
       end
 
+      #
+      # Handles a POST request
+      #
+      # @param (see #get)
+      #
+      # @return (see #get)
+      #
+      # @raise (see #get)
+      #
+
       def post(path, **params)
         request :post, path, params
       end
 
+      #
+      # Handles a PUT request
+      #
+      # @param (see #get)
+      #
+      # @return (see #get)
+      #
+      # @raise (see #get)
+      #
       def put(path, **params)
         request :put, path, params
       end
 
+      #
+      # Handles a DELETE request
+      #
+      # @param (see #get)
+      #
+      # @return (see #get)
+      #
+      # @raise (see #get)
+      #
       def delete(path, **params)
         request :delete, path, params
       end
@@ -48,9 +89,14 @@ module BridgeBankin
         Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
           api_response = http.request(yield)
 
-          return parse_response_body(api_response.body) if %w[200 201].include?(api_response.code)
-
-          handle_error(api_response)
+          case api_response.code
+          when "200", "201"
+            parse_response_body(api_response.body)
+          when "204"
+            {}
+          else
+            handle_error(api_response)
+          end
         end
       end