nordigen_ob_client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 720c32a7fae42823603e24b6e1afc0122e798620d18ac41bc4685d9a5b9e024c
-  data.tar.gz: 3e0b7ccbe0363566cada63f5e80e2d3d2895e8c7f4229117127bf4a7d7107a05
+  metadata.gz: 625277380446e9ac8bc08229f42c537b143a776838d361ad290d64099284ee04
+  data.tar.gz: f2e0315eb01dcefd77496d8ead8b329a0f60b7ee2d70faa89c362eaf68ac365f
 SHA512:
-  metadata.gz: becd5aec428708e1a522b4795080d6d011dc082e062c75ea2bc4916b63f732785acfae857e75fc8fb64144e2ab0a909cc636b54cf967819a36b130f1f6758e04
-  data.tar.gz: 5dfb8555ba43701eb67187ff263df392995e51375da96d7a6e01a4f2af688cec195efcb3f524cd203cc4e1dd7c281c9ba91dae00d10aa5141fbfe1632599ce86
+  metadata.gz: 7adf84acbbe3d9dbf9642fcaf6a05fcaaa50b58deed1568fd5ce703eb5f4fa89a68b0b9ec43ac82d28d4da2e68425a58878d14a628a9d050dbd2f559ade1f287
+  data.tar.gz: d49144ee26ca4280ec8a3002bf9cddb8921207c9edef6a69b3f785a4753c32ebdae3b038344a21b2b5f20a6c3b75244e519ed6fc6614479bf2cebf652741b8fe

data/lib/nordigen_ob_client.rb

@@ -34,6 +34,13 @@ class NordigenOBClient
                                     {content_type: :json, accept: :json})
     response = JSON.parse(response_json.body)
     @access_token = response["access"]
+
+    @request_header = {
+      content_type: :json,
+      accept: :json,
+      authorization: "Bearer #{@access_token}"
+    }
+
     @access_token
   end
 
@@ -52,15 +59,9 @@ class NordigenOBClient
   #
   #############################################################################
   def get_banks_by_country country
-    request_header = {
-      content_type: :json,
-      accept: :json,
-      authorization: "Bearer #{@access_token}"
-    }
-
     response = RestClient.get(
       "https://ob.nordigen.com/api/v2/institutions/?country=#{country}",
-      headers=request_header)
+      headers=@request_header)
 
     available_banks = JSON.parse(response.body,
                                 :external_encoding => 'iso-8859-1')
@@ -83,80 +84,144 @@ class NordigenOBClient
   #
   #############################################################################
   def list_accounts requisition_id
-    request_header = {
-      content_type: :json,
-      accept: :json,
-      authorization: "Bearer #{@access_token}"
-    }
-
     response = RestClient.get(
       "https://ob.nordigen.com/api/v2/requisitions/#{requisition_id}",
-      headers=request_header)
+      headers=@request_header)
     accounts = JSON.parse(response.body)
     accounts
   end
 
+  #############################################################################
+  #
+  # => Name: get_account_details
+  #
+  # => Description: Return's all the information available for the account.
+  #
+  # => Parameters: account_id: The id of the account (IBAN)
+  #                for which the information will be returned.
+  #
+  #
+  # => Returns: The details available for the account. They can vary from bank
+  #             to bank. The fields we see been returned always are:
+  #               - IBAN
+  #               - Currency
+  #               - Owner Name
+  #               - Product / account type (e.g. Savings, holding, etc.)
+  #               - BIC
+  #               - Usage: Private / Bureau
+  #
+  #############################################################################
   def get_account_details account_id
-    request_header = {
-      content_type: :json,
-      accept: :json,
-      authorization: "Bearer #{@access_token}"
-    }
-
     response = RestClient.get(
       "https://ob.nordigen.com/api/v2/accounts/#{account_id}/details",
-      headers=request_header)
+      headers=@request_header)
     accounts = JSON.parse(response.body)
     accounts
   end
 
 
+  #############################################################################
+  #
+  # => Name: get_account_balances
+  #
+  # => Description: Return's the balances for the given account. The balances
+  #                 can be more than one, since accounts allow overdraft or
+  #                 might have frozen limits.
+  #
+  # => Parameters: account_id: The id of the account (IBAN)
+  #                for which the balances will be returned.
+  #
+  #
+  # => Returns: The details available for the account. They can vary from bank
+  #             to bank. The fields we see been returned always are:
+  #               - Balance amount
+  #               - Currency
+  #               - Type of balances
+  #               - Balance date
+  #
+  #############################################################################
   def get_account_balances account_id
-    request_header = {
-      content_type: :json,
-      accept: :json,
-      authorization: "Bearer #{@access_token}"
-    }
-
     response = RestClient.get(
       "https://ob.nordigen.com/api/v2/accounts/#{account_id}/balances",
-      headers=request_header)
+      headers=@request_header)
     accounts = JSON.parse(response.body)
     accounts
   end
 
 
+  #############################################################################
+  #
+  # => Name: get_account_overview
+  #
+  # => Description: Return's the basic information available for the account.
+  #
+  # => Parameters: account_id: The id of the account (IBAN)
+  #                for which the information will be returned.
+  #
+  #
+  # => Returns: A summaru available for the account. THe fields included are:
+  #               - IBAN
+  #               - Nordigen's institution ID
+  #               - Status: ready, inactive
+  #               - Owner's name
+  #
+  #############################################################################
   def get_account_overview account_id
-    request_header = {
-      content_type: :json,
-      accept: :json,
-      authorization: "Bearer #{@access_token}"
-    }
-
     response = RestClient.get(
       "https://ob.nordigen.com/api/v2/accounts/#{account_id}",
-      headers=request_header)
+      headers=@request_header)
     accounts = JSON.parse(response.body)
     accounts
   end
 
 
+  #############################################################################
+  #
+  # => Name: get_account_transactions
+  #
+  # => Description: Return's the account statement for the last 90 days.
+  #
+  # => Parameters: account_id: The id of the account (IBAN)
+  #                for which the information will be returned.
+  #
+  #
+  # => Returns: The list of transactions performed. THe fields included are:
+  #               - Booking date, when the transaction was logged on the account.
+  #               - Reference date, when it actually occured.
+  #               - Transaction amount
+  #               - Currency
+  #               - Debitor BIC
+  #               - Creditor BIC
+  #
+  #############################################################################
   def get_account_transactions account_id
-    request_header = {
-      content_type: :json,
-      accept: :json,
-      authorization: "Bearer #{@access_token}"
-    }
-
     response = RestClient.get(
       "https://ob.nordigen.com/api/v2/accounts/#{account_id}/transactions",
-      headers=request_header)
+      headers=@request_header)
     accounts = JSON.parse(response.body)
     accounts
   end
 
 
-
+  #############################################################################
+  #
+  # => Name: create_requisition
+  #
+  # => Description: It creates a new requisition ID that will enable the user
+  #                 to connect his bank accounts.
+  #
+  # => Parameters: redirect_url: The URL to which the user will be redirected
+  #                after logging in to his bank environment.
+  #
+  #                selected_bank_id: The Nordigen ID of the bank the user
+  #                will be redirected.
+  #
+  #                reference: A unique user identifier that will associate
+  #                the user who will log in with the new requisition ID.
+  #
+  # => Returns: The access token
+  #
+  #############################################################################
   def create_requisition redirect_url, selected_bank_id, reference
     request_body = {
                     "redirect" => redirect_url,
@@ -165,31 +230,30 @@ class NordigenOBClient
                     "reference" => reference
     }.to_json
 
-    request_header = {
-      content_type: :json,
-      accept: :json,
-      authorization: "Bearer #{@access_token}"
-    }
-
     response = RestClient.post(
       "https://ob.nordigen.com/api/v2/requisitions/",
       request_body,
-      headers=request_header)
+      headers=@request_header)
     JSON.parse(response.body)
   end
 
 
+  #############################################################################
+  #
+  # => Name: delete_requisition
+  #
+  # => Description: It deletes the provided requisition ID.
+  #
+  # => Parameters: requisition_id: The requisition to delete.
+  #
+  # => Returns: The result of the operation
+  #
+  #############################################################################
   def delete_requisition requisition_id
-    request_header = {
-      content_type: :json,
-      accept: :json,
-      authorization: "Bearer #{@access_token}"
-    }
-
     response = RestClient.delete(
       "https://ob.nordigen.com/api/v2/requisitions/#{requisition_id}",
       request_body,
-      headers=request_header)
+      headers=@request_header)
     JSON.parse(response.body)
     response
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nordigen_ob_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Angelos Kapsimanis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby client for Nordigen's Open Banking v2.0 API. Look at https://nordigen.com/en/account_information_documenation/api-documention/overview/
   for more details.