mirror of
https://github.com/we-promise/sure.git
synced 2026-04-19 12:04:08 +00:00
Initial enable banking implementation (#382)
* Initial enable banking implementation * Handle multiple connections * Amount fixes * Account type mapping * Add option to skip accounts * Update schema.rb * Transaction fixes * Provider fixes * FIX account identifier * FIX support unlinking * UI style fixes * FIX safe redirect and brakeman issue * FIX - pagination max fix - wrap crud in transaction logic * FIX api uid access - The Enable Banking API expects the UUID (uid from the API response) to fetch balances/transactions, not the identification_hash * FIX add new connection * FIX erb code * Alert/notice box overflow protection * Give alert/notification boxes room to grow (3 lines max) * Add "Enable Banking (beta)" to `/settings/bank_sync` * Make Enable Banking section collapsible like all others * Add callback hint to error message --------- Co-authored-by: Juan José Mata <juanjo.mata@gmail.com>
This commit is contained in:
soky srm
242
app/models/provider/enable_banking.rb
Normal file
242
app/models/provider/enable_banking.rb
Normal file
@@ -0,0 +1,242 @@
|
||||
require "cgi"
|
||||
|
||||
class Provider::EnableBanking
|
||||
include HTTParty
|
||||
|
||||
BASE_URL = "https://api.enablebanking.com".freeze
|
||||
|
||||
headers "User-Agent" => "Sure Finance Enable Banking Client"
|
||||
default_options.merge!(verify: true, ssl_verify_mode: OpenSSL::SSL::VERIFY_PEER, timeout: 120)
|
||||
|
||||
attr_reader :application_id, :private_key
|
||||
|
||||
def initialize(application_id:, client_certificate:)
|
||||
@application_id = application_id
|
||||
@private_key = extract_private_key(client_certificate)
|
||||
end
|
||||
|
||||
# Get list of available ASPSPs (banks) for a country
|
||||
# @param country [String] ISO 3166-1 alpha-2 country code (e.g., "GB", "DE", "FR")
|
||||
# @return [Array<Hash>] List of ASPSPs
|
||||
def get_aspsps(country:)
|
||||
response = self.class.get(
|
||||
"#{BASE_URL}/aspsps",
|
||||
headers: auth_headers,
|
||||
query: { country: country }
|
||||
)
|
||||
|
||||
handle_response(response)
|
||||
rescue SocketError, Net::OpenTimeout, Net::ReadTimeout => e
|
||||
raise EnableBankingError.new("Exception during GET request: #{e.message}", :request_failed)
|
||||
end
|
||||
|
||||
# Initiate authorization flow - returns a redirect URL for the user
|
||||
# @param aspsp_name [String] Name of the ASPSP from get_aspsps
|
||||
# @param aspsp_country [String] Country code for the ASPSP
|
||||
# @param redirect_url [String] URL to redirect user back to after auth
|
||||
# @param state [String] Optional state parameter to pass through
|
||||
# @param psu_type [String] "personal" or "business"
|
||||
# @return [Hash] Contains :url and :authorization_id
|
||||
def start_authorization(aspsp_name:, aspsp_country:, redirect_url:, state: nil, psu_type: "personal")
|
||||
body = {
|
||||
access: {
|
||||
valid_until: (Time.current + 90.days).iso8601
|
||||
},
|
||||
aspsp: {
|
||||
name: aspsp_name,
|
||||
country: aspsp_country
|
||||
},
|
||||
state: state,
|
||||
redirect_url: redirect_url,
|
||||
psu_type: psu_type
|
||||
}.compact
|
||||
|
||||
response = self.class.post(
|
||||
"#{BASE_URL}/auth",
|
||||
headers: auth_headers.merge("Content-Type" => "application/json"),
|
||||
body: body.to_json
|
||||
)
|
||||
|
||||
handle_response(response)
|
||||
rescue SocketError, Net::OpenTimeout, Net::ReadTimeout => e
|
||||
raise EnableBankingError.new("Exception during POST request: #{e.message}", :request_failed)
|
||||
end
|
||||
|
||||
# Exchange authorization code for a session
|
||||
# @param code [String] The authorization code from the callback
|
||||
# @return [Hash] Contains :session_id and :accounts
|
||||
def create_session(code:)
|
||||
body = {
|
||||
code: code
|
||||
}
|
||||
|
||||
response = self.class.post(
|
||||
"#{BASE_URL}/sessions",
|
||||
headers: auth_headers.merge("Content-Type" => "application/json"),
|
||||
body: body.to_json
|
||||
)
|
||||
|
||||
handle_response(response)
|
||||
rescue SocketError, Net::OpenTimeout, Net::ReadTimeout => e
|
||||
raise EnableBankingError.new("Exception during POST request: #{e.message}", :request_failed)
|
||||
end
|
||||
|
||||
# Get session information
|
||||
# @param session_id [String] The session ID
|
||||
# @return [Hash] Session info including accounts
|
||||
def get_session(session_id:)
|
||||
response = self.class.get(
|
||||
"#{BASE_URL}/sessions/#{session_id}",
|
||||
headers: auth_headers
|
||||
)
|
||||
|
||||
handle_response(response)
|
||||
rescue SocketError, Net::OpenTimeout, Net::ReadTimeout => e
|
||||
raise EnableBankingError.new("Exception during GET request: #{e.message}", :request_failed)
|
||||
end
|
||||
|
||||
# Delete a session (revoke consent)
|
||||
# @param session_id [String] The session ID
|
||||
def delete_session(session_id:)
|
||||
response = self.class.delete(
|
||||
"#{BASE_URL}/sessions/#{session_id}",
|
||||
headers: auth_headers
|
||||
)
|
||||
|
||||
handle_response(response)
|
||||
rescue SocketError, Net::OpenTimeout, Net::ReadTimeout => e
|
||||
raise EnableBankingError.new("Exception during DELETE request: #{e.message}", :request_failed)
|
||||
end
|
||||
|
||||
# Get account details
|
||||
# @param account_id [String] The account ID (UID from Enable Banking)
|
||||
# @return [Hash] Account details
|
||||
def get_account_details(account_id:)
|
||||
encoded_id = CGI.escape(account_id.to_s)
|
||||
response = self.class.get(
|
||||
"#{BASE_URL}/accounts/#{encoded_id}/details",
|
||||
headers: auth_headers
|
||||
)
|
||||
|
||||
handle_response(response)
|
||||
rescue SocketError, Net::OpenTimeout, Net::ReadTimeout => e
|
||||
raise EnableBankingError.new("Exception during GET request: #{e.message}", :request_failed)
|
||||
end
|
||||
|
||||
# Get account balances
|
||||
# @param account_id [String] The account ID (UID from Enable Banking)
|
||||
# @return [Hash] Balance information
|
||||
def get_account_balances(account_id:)
|
||||
encoded_id = CGI.escape(account_id.to_s)
|
||||
response = self.class.get(
|
||||
"#{BASE_URL}/accounts/#{encoded_id}/balances",
|
||||
headers: auth_headers
|
||||
)
|
||||
|
||||
handle_response(response)
|
||||
rescue SocketError, Net::OpenTimeout, Net::ReadTimeout => e
|
||||
raise EnableBankingError.new("Exception during GET request: #{e.message}", :request_failed)
|
||||
end
|
||||
|
||||
# Get account transactions
|
||||
# @param account_id [String] The account ID (UID from Enable Banking)
|
||||
# @param date_from [Date, nil] Start date for transactions
|
||||
# @param date_to [Date, nil] End date for transactions
|
||||
# @param continuation_key [String, nil] For pagination
|
||||
# @return [Hash] Transactions and continuation_key for pagination
|
||||
def get_account_transactions(account_id:, date_from: nil, date_to: nil, continuation_key: nil)
|
||||
encoded_id = CGI.escape(account_id.to_s)
|
||||
query_params = {}
|
||||
query_params[:date_from] = date_from.to_date.iso8601 if date_from
|
||||
query_params[:date_to] = date_to.to_date.iso8601 if date_to
|
||||
query_params[:continuation_key] = continuation_key if continuation_key
|
||||
|
||||
response = self.class.get(
|
||||
"#{BASE_URL}/accounts/#{encoded_id}/transactions",
|
||||
headers: auth_headers,
|
||||
query: query_params.presence
|
||||
)
|
||||
|
||||
handle_response(response)
|
||||
rescue SocketError, Net::OpenTimeout, Net::ReadTimeout => e
|
||||
raise EnableBankingError.new("Exception during GET request: #{e.message}", :request_failed)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def extract_private_key(certificate_pem)
|
||||
# Extract private key from PEM certificate
|
||||
OpenSSL::PKey::RSA.new(certificate_pem)
|
||||
rescue OpenSSL::PKey::RSAError => e
|
||||
Rails.logger.error "Enable Banking: Failed to parse private key: #{e.message}"
|
||||
raise EnableBankingError.new("Invalid private key in certificate: #{e.message}", :invalid_certificate)
|
||||
end
|
||||
|
||||
def generate_jwt
|
||||
now = Time.current.to_i
|
||||
|
||||
header = {
|
||||
typ: "JWT",
|
||||
alg: "RS256",
|
||||
kid: application_id
|
||||
}
|
||||
|
||||
payload = {
|
||||
iss: "enablebanking.com",
|
||||
aud: "api.enablebanking.com",
|
||||
iat: now,
|
||||
exp: now + 3600 # 1 hour expiry
|
||||
}
|
||||
|
||||
# Encode JWT
|
||||
JWT.encode(payload, private_key, "RS256", header)
|
||||
end
|
||||
|
||||
def auth_headers
|
||||
{
|
||||
"Authorization" => "Bearer #{generate_jwt}",
|
||||
"Accept" => "application/json"
|
||||
}
|
||||
end
|
||||
|
||||
def handle_response(response)
|
||||
case response.code
|
||||
when 200, 201
|
||||
parse_response_body(response)
|
||||
when 204
|
||||
{}
|
||||
when 400
|
||||
raise EnableBankingError.new("Bad request to Enable Banking API: #{response.body}", :bad_request)
|
||||
when 401
|
||||
raise EnableBankingError.new("Invalid credentials or expired JWT", :unauthorized)
|
||||
when 403
|
||||
raise EnableBankingError.new("Access forbidden - check your application permissions", :access_forbidden)
|
||||
when 404
|
||||
raise EnableBankingError.new("Resource not found", :not_found)
|
||||
when 422
|
||||
raise EnableBankingError.new("Validation error from Enable Banking API: #{response.body}", :validation_error)
|
||||
when 429
|
||||
raise EnableBankingError.new("Rate limit exceeded. Please try again later.", :rate_limited)
|
||||
else
|
||||
raise EnableBankingError.new("Failed to fetch data: #{response.code} #{response.message} - #{response.body}", :fetch_failed)
|
||||
end
|
||||
end
|
||||
|
||||
def parse_response_body(response)
|
||||
return {} if response.body.blank?
|
||||
|
||||
JSON.parse(response.body, symbolize_names: true)
|
||||
rescue JSON::ParserError => e
|
||||
Rails.logger.error "Enable Banking API: Failed to parse response: #{e.message}"
|
||||
raise EnableBankingError.new("Failed to parse API response", :parse_error)
|
||||
end
|
||||
|
||||
class EnableBankingError < StandardError
|
||||
attr_reader :error_type
|
||||
|
||||
def initialize(message, error_type = :unknown)
|
||||
super(message)
|
||||
@error_type = error_type
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user