nordigen_ob_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a34a748612b3bf2535faffb6c6d43bad91ff0b94ae75fa1725881814fbee6674
+  data.tar.gz: 2f9e5560099bfd39663deeff53a8f4d17b2a6dc9af4a4f985785ac331559df53
+SHA512:
+  metadata.gz: 06f56f9153e732e8cd7c4daeaff5809beb9c5b5e570a974a025b32c705e82abceb18863ce7aae6cf293518e46d686e1865af38a1f646132512484fba1952c22f
+  data.tar.gz: a04466070b4a9c9332a95098f422f254a4b3e5683a2d073dda48b7d6e57519bfe8e9b5b1c9391b64a4b04672d88495616f208497b4012e3b70dad0bc26c47547

data/lib/nordigen_ob_client.rb

@@ -0,0 +1,197 @@
+require 'json'
+require 'net/http'
+require 'rest-client'
+
+class NordigenOBClient
+
+  def initialize
+  end
+
+  #############################################################################
+  #
+  # => Name: get_access_token
+  #
+  # => Description: Retrieve the access token that will be used to access all
+  #                 other endpoints in Nordigen's backend.
+  #
+  # => Parameters: secret_id: The Secret ID part of the credentials,
+  #                           provided by Nordigen.
+  #
+  #                secret_key: The Secret Key part of the credentials,
+  #                            provided by Nordigen.
+  #
+  # => Returns: The access token
+  #
+  #############################################################################
+  def get_access_token secret_id, secret_key
+    access_token_params = {
+      "secret_id" => secret_id,
+      "secret_key" => secret_key
+    }.to_json
+
+    response_json = RestClient.post("https://ob.nordigen.com/api/v2/token/new/",
+                                    access_token_params,
+                                    {content_type: :json, accept: :json})
+    response = JSON.parse(response_json.body)
+    @access_token = response["access"]
+    @access_token
+  end
+
+  #############################################################################
+  #
+  # => Name: get_banks_by_country
+  #
+  # => Description: Returns a list of the available institutions by country,
+  #                 including
+  #
+  # => Parameters: country: The selected country, in ISO 3166 format.
+  #                         Supported countries are EEA countries.
+  #
+  #
+  # => Returns: The list of supported institutions in the selected country.
+  #
+  #############################################################################
+  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)
+
+    available_banks = JSON.parse(response.body,
+                                :external_encoding => 'iso-8859-1')
+    available_banks
+  end
+
+
+  #############################################################################
+  #
+  # => Name: list_accounts
+  #
+  # => Description: Return a list of the available accounts connected to the
+  #                 given user account.
+  #
+  # => Parameters: requisition_id: The id of the requisition (bank login)
+  #                for which the parameters will be parsed.
+  #
+  #
+  # => Returns: The list of available accounts.
+  #
+  #############################################################################
+  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)
+    accounts = JSON.parse(response.body)
+    accounts
+  end
+
+  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)
+    accounts = JSON.parse(response.body)
+    accounts
+  end
+
+
+  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)
+    accounts = JSON.parse(response.body)
+    accounts
+  end
+
+
+  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)
+    accounts = JSON.parse(response.body)
+    accounts
+  end
+
+
+  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)
+    accounts = JSON.parse(response.body)
+    accounts
+  end
+
+
+
+  def create_requisition redirect_url, selected_bank_id, reference
+    request_body = {
+                    "redirect" => redirect_url,
+                    "institution_id" => selected_bank_id,
+                    "user_language" => "EN",
+                    "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)
+    JSON.parse(response.body)
+  end
+
+
+  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)
+    JSON.parse(response.body)
+    response
+  end
+
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: nordigen_ob_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Angelos Kapsimanis
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-31 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.
+email: angelos@neffoss.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nordigen_ob_client.rb
+homepage: https://github.com/neffoss/nordigen_ob_client
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Nordigen's Open Banking v2.0 API client
+test_files: []