nordigen-ruby 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a0a198d2708a354e0cb9c3a4dc0a5b3c86a48558a3cbc7fdd194a5e6f51c339
+  data.tar.gz: cb7f41ae35dac9c280cccde6a0e9d3881d3903569254c3a14e2e19ab93885f88
+SHA512:
+  metadata.gz: 5fff49c6c59a8b05e8777a84e9b1423a36936b73762f39e02a101b363ad3c7e69a4b14caeb6e6cbcfcac4f1bd69161ddc7f2d06f5b69291dbdb4613f04cad9fa
+  data.tar.gz: ae06748d1a8369a1e6dc5e0a61a3a36218044408734450dbac06173feb5125cece179624725ce47d519493933605e4aa832a748fdd9b514a19d2432606c2ae95

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [1.0.0] - 2022-01-13
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nordigen.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "faraday", "~> 1.8.0"
+gem "faraday_middleware", "~> 1.2.0"
+gem "test-unit", "~> 3.5.3"

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    nordigen-ruby (1.0.0)
+      dotenv (~> 2.7.6)
+      faraday (~> 1.8.0)
+      faraday_middleware (~> 1.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    multipart-post (2.1.1)
+    power_assert (2.0.1)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+    test-unit (3.5.3)
+      power_assert
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv (~> 2.7.6)
+  faraday (~> 1.8.0)
+  faraday_middleware (~> 1.2.0)
+  nordigen-ruby!
+  rake (~> 13.0)
+  test-unit (~> 3.5.3)
+
+BUNDLED WITH
+   2.3.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Nordigen Solutions SIA
+
+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,104 @@
+# Nordigen Ruby Library
+
+This is official Ruby client library for [Nordigen](https://nordigen.com/en).
+
+For a full list of endpoints and arguments, see the [docs](https://nordigen.com/en/account_information_documenation/api-documention/overview/).
+
+Before starting to use API you will need to create a new secret and get your `SECRET_ID` and `SECRET_KEY` from the [Nordigen's Open Banking Portal](https://ob.nordigen.com/user-secrets/).
+
+## Requirements
+
+* Ruby 2.6+
+
+
+## Installation
+
+
+Install library
+
+```
+gem install nordigen-ruby
+```
+
+## Example application
+
+Example code can be found in `main.rb` file and Ruby on Rails example application can be found in `example` directory
+
+## Quickstart
+
+
+```ruby
+require 'securerandom'
+require 'nordigen-ruby'
+
+# Get secret_id and secret_key from ob.nordigen.com portal and pass to NordigenClient or load from .env file
+client = Nordigen::NordigenClient.new(
+  secret_id: "SECRET_ID",
+  secret_key: "SECRET_KEY"
+)
+
+# Generate new access token. Token is valid for 24 hours
+token_data = client.generate_token()
+
+# Use existing token
+client.set_token("YOUR_TOKEN")
+
+# Get access and refresh token
+# Note: access_token is automatically injected to other requests after you successfully obtain it
+access_token = token_data.access
+refresh_token = token_data.refresh
+
+# Exchange refresh token. Refresh token is valid for 30 days
+refresh_token = client.exchange_token(refresh_token)
+
+# Get all institution by providing country code in ISO 3166 format
+institutions = client.institution.get_institutions("LV")
+
+# Institution id can be gathered from get_institutions response.
+# Example Revolut ID
+id = "REVOLUT_REVOGB21"
+
+# Initialize bank authorization session
+# Returns requisition_id and link to initiate authorization with a bank
+init = client.init_session(
+  # redirect url after successful authentication
+  redirect_url: "https://nordigen.com",
+  # institution id
+  institution_id: id,
+  # a unique user ID of someone who's using your services, usually it's a UUID
+  reference_id: SecureRandom.uuid
+)
+
+link = init.link # bank authorization link
+puts init.link
+requisition_id = init.requisition_id # requisition id that is needed to get an account_id
+```
+
+After successful authorization with a bank you can fetch your data (details, balances, transactions)
+
+
+## Fetching account metadata, balances, details and transactions
+
+```ruby
+
+# Get account id after you have completed authorization with a bank.
+accounts = client.requisition.get_requisition_by_id(requisition_id)
+# Get account id from list
+account_id =  accounts.accounts[0]
+
+# Instantiate account object
+account = client.account_api(account_id)
+
+# Fetch account metadata
+meta_data = account.get_metadata()
+# Fetch details
+details = account.get_details()
+# Fetch balances
+balances = account.get_balances()
+# Fetch transactions
+transactions = account.get_transactions()
+```
+
+## Support
+
+For any inquiries please contact support at [support@nordigen.com](support@nordigen.com) or create an issue in repository.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "nordigen-ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nordigen-ruby.rb

@@ -0,0 +1,103 @@
+require "faraday"
+require "faraday_middleware"
+
+require "nordigen_ruby/api/institutions"
+require "nordigen_ruby/api/agreements"
+require "nordigen_ruby/api/requisitions"
+require "nordigen_ruby/api/account"
+
+module Nordigen
+    class NordigenClient
+
+        BASE_URL = "https://ob.nordigen.com/api/v2/"
+
+        @@headers = {
+            "accept" => "application/json",
+            "Content-Type" => "application/json",
+            "User-Agent" => "Nordigen-Ruby-v2"
+        }
+
+        attr_reader :secret_id, :secret_key, :institution, :agreement, :requisition
+
+        def initialize(secret_id:, secret_key:)
+            @secret_id = secret_id
+            @secret_key = secret_key
+            @institution = InstitutionsApi.new(client=self)
+            @agreement = AgreementsApi.new(client=self)
+            @requisition = RequisitionsApi.new(client=self)
+        end
+
+        def request
+            # HTTP client request
+            @request ||= Faraday.new do |conn|
+                conn.url_prefix = BASE_URL
+                conn.headers = @@headers
+                conn.request :json
+                conn.response :json, parser_options: { object_class: OpenStruct }
+            end
+        end
+
+        def set_token(access_token)
+            # Use existing token
+            @@headers["Authorization"] = "Bearer #{access_token}"
+        end
+
+        def get_token
+            # Get token
+            return request.headers["Authorization"]
+        end
+
+        def generate_token
+            # Generate new access & refresh token
+            payload = {
+                "secret_key": @secret_key,
+                "secret_id": @secret_id
+            }
+            response = self.request.post("token/new/", payload)
+            if !response.success?
+                raise Exception.new response.body
+            end
+
+            @@headers["Authorization"] = "Bearer #{response.body.access}"
+            request.headers = @@headers
+            return response.body
+        end
+
+        def exchange_token(refresh_token)
+            # Exchange refresh token for access token
+            payload = {"refresh": refresh_token}
+            response = self.request.post("token/refresh/", payload).body
+            @@headers["Authorization"] = "Bearer #{response.access}"
+            request.headers = @@headers
+            return response
+        end
+
+
+        def account(account_id)
+            # Create Account instance
+            return AccountApi.new(client: self, account_id: account_id)
+        end
+
+        def init_session(redirect_url:, institution_id:, reference_id:, max_historical_days: 90)
+            # Factory method that creates authorization in a specific institution
+            # and are responsible for the following steps:
+            #   * Creates agreement
+            #   * Creates requisiton
+
+            # Create agreement
+            new_agreement = @agreement.create_agreement(
+                institution_id: institution_id,
+                max_historical_days: max_historical_days
+            )
+            # Create requisition
+            new_requsition = @requisition.create_requisition(
+                redirect_url: redirect_url,
+                reference: reference_id,
+                institution_id: institution_id
+        )
+
+            return new_requsition
+        end
+
+    end
+end

data/lib/nordigen_ruby/api/account.rb

@@ -0,0 +1,45 @@
+module Nordigen
+    class AccountApi
+
+        ENDPOINT = "accounts/"
+        attr_reader :client, :account_id
+
+        def initialize(client:, account_id:)
+            @client = client
+            @account_id = account_id
+        end
+
+        def get(path = nil)
+            # Create Get request
+            url = "#{ENDPOINT}#{@account_id}/"
+            
+            if path
+                url = "#{url}#{path}/"
+            end
+
+            return client.request.get(url).body
+        end
+
+        def get_metadata
+            # Access account metadata
+            return get()
+        end
+
+        def get_details
+            # Access account details
+            return get("details")
+        end
+
+
+        def get_balances
+            #  Access account balances
+            return get("balances")
+        end
+
+        def get_transactions
+            # Access account transactions
+            return get("transactions")
+        end
+
+    end
+end

data/lib/nordigen_ruby/api/agreements.rb

@@ -0,0 +1,54 @@
+module Nordigen
+    class AgreementsApi
+
+        ENDPOINT = "agreements/enduser/"
+        attr_reader :client
+
+        def initialize(client)
+            # Nordigen client initialization
+            @client = client
+        end
+
+        def create_agreement(institution_id:, max_historical_days: 90, access_valid_for_days: 90, access_scope: [
+            "balances",
+            "details",
+            "transactions"
+        ])
+            # Create enduser agreement
+            payload = {
+                "institution_id": institution_id,
+                "max_historical_days": max_historical_days,
+                "access_valid_for_days": access_valid_for_days,
+                "access_scope": access_scope,
+            };
+            return client.request.post(ENDPOINT, payload).body
+        end
+
+
+        def get_agreements(limit: 100, offset: 0)
+            # Get list of agreements
+            params = {limit: limit, offset: offset}
+            return client.request.get(ENDPOINT, params).body
+        end
+
+        def get_agreement_by_id(agreement_id)
+            # Get agreemenet by id
+            return client.request.get("#{ENDPOINT}#{agreement_id}/").body
+        end
+
+        def delete_agreement(agreement_id)
+            # Delete agreement by id
+            return client.request.delete("#{ENDPOINT}#{agreement_id}/").body
+        end
+
+        def accept_agreement(agreement_id:, ip:, user_agent:)
+            # Accept end user agreement
+            payload = {
+                'user_agent': user_agent,
+                'ip_address': ip
+            }
+            return client.request.put("#{ENDPOINT}#{agreement_id}/accept/").body
+        end
+
+    end
+end

data/lib/nordigen_ruby/api/institutions.rb

@@ -0,0 +1,23 @@
+module Nordigen
+    class InstitutionsApi
+
+        ENDPOINT = "institutions"
+        attr_reader :client
+
+        def initialize(client)
+            # Nordigen client initialization
+            @client = client
+        end
+
+        def get_institutions(country)
+            # Get list of institutions
+            return client.request.get("#{ENDPOINT}/?country=#{country}").body
+        end
+
+        def get_institution_by_id(id)
+            # Get single institution by id
+            return client.request.get("#{ENDPOINT}/#{id}/").body
+        end
+
+    end
+end

data/lib/nordigen_ruby/api/requisitions.rb

@@ -0,0 +1,47 @@
+
+module Nordigen
+    class RequisitionsApi
+
+        ENDPOINT = "requisitions/"
+        attr_reader :client
+
+        def initialize(client)
+            # Nordigen client initialization
+            @client = client
+        end
+
+        def create_requisition(redirect_url:, reference:, institution_id:, user_language: "en", agreement: nil)
+            # Create requisition. For creating links and retrieving accounts.
+            payload = {
+                "redirect": redirect_url,
+                "reference": reference,
+                "institution_id": institution_id,
+                "user_language": user_language,
+            } 
+
+            if agreement
+                payload["agreement"] = agreement
+            end
+                        
+            return client.request.post(ENDPOINT, payload).body
+        end
+
+        def get_requisitions(limit: 100, offset: 0)
+            # Get all requisitions
+            params = {limit: limit, offset: offset}
+            return client.request.get(ENDPOINT, params).body
+        end
+
+
+        def get_requisition_by_id(requisition_id)
+            # Get requisition by id
+            return client.request.get("#{ENDPOINT}#{requisition_id}/").body
+        end
+
+        def delete_requisition(requisition_id)
+            # Delete requisition by id 
+            return client.request.delete("#{ENDPOINT}#{requisition_id}/").body
+        end
+
+    end
+end

data/lib/nordigen_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nordigen
+  VERSION = "1.0.1"
+end

data/nordigen.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+
+require "nordigen_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "nordigen-ruby"
+  spec.version = Nordigen::VERSION
+  spec.authors = ["Nordigen Solutions"]
+  spec.email = ["support@nordigen.com"]
+  spec.summary = "Nordigen client for Ruby"
+  spec.homepage = "https://github.com/nordigen/nordigen-ruby"
+  spec.description = "Nordigen official API client for Ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = "https://github.com/nordigen/nordigen-ruby"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/nordigen/nordigen-ruby/issues"
+  spec.metadata["changelog_uri"] = "https://github.com/nordigen/nordigen-ruby/blob/master/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://github.com/nordigen/nordigen-ruby"
+  spec.metadata["github_repo"] = "https://github.com/nordigen/nordigen-ruby"
+  spec.metadata["source_code_uri"] = "https://github.com/nordigen/nordigen-ruby"
+
+  ignored = Regexp.union(
+    /\A\.env.template/,
+    /\A\.git/,
+    /\Atest/,
+    /\Aexample/,
+    /\Amain.rb/
+  )
+  spec.files = `git ls-files`.split("\n").reject { |f| ignored.match(f) }
+  spec.executables   = `git ls-files -- bin/*`.split("\n")
+                      .map { |f| ::File.basename(f) }
+
+  spec.add_dependency "faraday", "~> 1.8.0"
+  spec.add_dependency "faraday_middleware", "~> 1.2.0"
+
+  spec.require_paths = ["lib"]
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: nordigen-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Nordigen Solutions
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Nordigen official API client for Ruby
+email:
+- support@nordigen.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nordigen-ruby.rb
+- lib/nordigen_ruby/api/account.rb
+- lib/nordigen_ruby/api/agreements.rb
+- lib/nordigen_ruby/api/institutions.rb
+- lib/nordigen_ruby/api/requisitions.rb
+- lib/nordigen_ruby/version.rb
+- nordigen.gemspec
+homepage: https://github.com/nordigen/nordigen-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nordigen/nordigen-ruby
+  bug_tracker_uri: https://github.com/nordigen/nordigen-ruby/issues
+  changelog_uri: https://github.com/nordigen/nordigen-ruby/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/nordigen/nordigen-ruby
+  github_repo: https://github.com/nordigen/nordigen-ruby
+  source_code_uri: https://github.com/nordigen/nordigen-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Nordigen client for Ruby
+test_files: []