The personal finance app for everyone
Initial pass at Plaid EU (#1555)
Josh Pigford4bf72506d502
diff --git a/.env.example b/.env.exampleindex ef90f4a3..5253039c 100644--- a/.env.example+++ b/.env.example@@ -118,4 +118,6 @@ STRIPE_WEBHOOK_SECRET=#PLAID_CLIENT_ID=PLAID_SECRET=-PLAID_ENV=\ No newline at end of file+PLAID_ENV=+PLAID_EU_CLIENT_ID=+PLAID_EU_SECRET=diff --git a/app/controllers/concerns/accountable_resource.rb b/app/controllers/concerns/accountable_resource.rbindex 1cdf7baa..f149adc3 100644--- a/app/controllers/concerns/accountable_resource.rb+++ b/app/controllers/concerns/accountable_resource.rb@@ -55,7 +55,8 @@ module AccountableResource@link_token = Current.family.get_link_token(webhooks_url: webhooks_url,redirect_url: accounts_url,- accountable_type: accountable_type.name+ accountable_type: accountable_type.name,+ region: Current.family.country.to_s.downcase == "us" ? :us : :eu)enddiff --git a/app/controllers/plaid_items_controller.rb b/app/controllers/plaid_items_controller.rbindex c0ac89ad..64537896 100644--- a/app/controllers/plaid_items_controller.rb+++ b/app/controllers/plaid_items_controller.rb@@ -5,6 +5,7 @@ class PlaidItemsController < ApplicationControllerCurrent.family.plaid_items.create_from_public_token(plaid_item_params[:public_token],item_name: item_name,+ region: plaid_item_params[:region])redirect_to accounts_path, notice: t(".success")@@ -29,7 +30,7 @@ class PlaidItemsController < ApplicationControllerenddef plaid_item_params- params.require(:plaid_item).permit(:public_token, metadata: {})+ params.require(:plaid_item).permit(:public_token, :region, metadata: {})enddef item_namediff --git a/app/javascript/controllers/plaid_controller.js b/app/javascript/controllers/plaid_controller.jsindex 14b0c182..5f4f1d29 100644--- a/app/javascript/controllers/plaid_controller.js+++ b/app/javascript/controllers/plaid_controller.js@@ -4,6 +4,7 @@ import { Controller } from "@hotwired/stimulus";export default class extends Controller {static values = {linkToken: String,+ region: { type: String, default: "us" }};open() {@@ -31,6 +32,7 @@ export default class extends Controller {plaid_item: {public_token: public_token,metadata: metadata,+ region: this.regionValue},}),}).then((response) => {diff --git a/app/models/concerns/plaidable.rb b/app/models/concerns/plaidable.rbindex ddecd893..838b4837 100644--- a/app/models/concerns/plaidable.rb+++ b/app/models/concerns/plaidable.rb@@ -5,10 +5,19 @@ module Plaidabledef plaid_providerProvider::Plaid.new if Rails.application.config.plaidend++ def plaid_eu_provider+ Provider::Plaid.new if Rails.application.config.plaid_eu+ end++ def plaid_provider_for(plaid_item)+ return nil unless plaid_item+ plaid_item.eu? ? plaid_eu_provider : plaid_provider+ endendprivate- def plaid_provider- self.class.plaid_provider+ def plaid_provider_for(plaid_item)+ self.class.plaid_provider_for(plaid_item)endenddiff --git a/app/models/family.rb b/app/models/family.rbindex f2f1b530..4b36fcd8 100644--- a/app/models/family.rb+++ b/app/models/family.rb@@ -1,3 +1,4 @@+# rubocop:disable Layout/ElseAlignment, Layout/IndentationWidthclass Family < ApplicationRecordinclude Plaidable, Syncable@@ -47,14 +48,22 @@ class Family < ApplicationRecordsuper || accounts.manual.any?(&:syncing?) || plaid_items.any?(&:syncing?)end- def get_link_token(webhooks_url:, redirect_url:, accountable_type: nil)- return nil unless plaid_provider+ def get_link_token(webhooks_url:, redirect_url:, accountable_type: nil, region: :us)+ provider = case region+ when :eu+ self.class.plaid_eu_provider+ else+ self.class.plaid_provider+ end++ return nil unless provider- plaid_provider.get_link_token(+ provider.get_link_token(user_id: id,webhooks_url: webhooks_url,redirect_url: redirect_url,- accountable_type: accountable_type+ accountable_type: accountable_type,+ eu: region == :eu).link_tokenend@@ -229,3 +238,4 @@ class Family < ApplicationRecord)endend+# rubocop:enable Layout/ElseAlignment, Layout/IndentationWidthdiff --git a/app/models/plaid_item.rb b/app/models/plaid_item.rbindex cbbe14bb..a41d96a9 100644--- a/app/models/plaid_item.rb+++ b/app/models/plaid_item.rb@@ -1,6 +1,8 @@class PlaidItem < ApplicationRecordinclude Plaidable, Syncable+ enum :plaid_region, { us: "us", eu: "eu" }+if Rails.application.credentials.active_record_encryption.present?encrypts :access_token, deterministic: trueend@@ -19,13 +21,14 @@ class PlaidItem < ApplicationRecordscope :ordered, -> { order(created_at: :desc) }class << self- def create_from_public_token(token, item_name:)+ def create_from_public_token(token, item_name:, region: "us")response = plaid_provider.exchange_public_token(token)new_plaid_item = create!(name: item_name,plaid_id: response.item_id,access_token: response.access_token,+ plaid_region: region)new_plaid_item.sync_later@@ -56,10 +59,11 @@ class PlaidItem < ApplicationRecordprivatedef fetch_and_load_plaid_datadata = {}- item = plaid_provider.get_item(access_token).item+ provider = plaid_provider_for(self)+ item = provider.get_item(access_token).itemupdate!(available_products: item.available_products, billed_products: item.billed_products)- fetched_accounts = plaid_provider.get_item_accounts(self).accounts+ fetched_accounts = provider.get_item_accounts(self).accountsdata[:accounts] = fetched_accounts || []internal_plaid_accounts = fetched_accounts.map do |account|diff --git a/app/models/provider/plaid.rb b/app/models/provider/plaid.rbindex 7b95cb88..813102a0 100644--- a/app/models/provider/plaid.rb+++ b/app/models/provider/plaid.rb@@ -68,13 +68,13 @@ class Provider::Plaid@client = self.class.clientend- def get_link_token(user_id:, webhooks_url:, redirect_url:, accountable_type: nil)+ def get_link_token(user_id:, webhooks_url:, redirect_url:, accountable_type: nil, eu: false)request = Plaid::LinkTokenCreateRequest.new({user: { client_user_id: user_id },client_name: "Maybe Finance",products: [ get_primary_product(accountable_type) ],additional_consented_products: get_additional_consented_products(accountable_type),- country_codes: [ "US", "CA" ],+ country_codes: get_country_codes(eu),language: "en",webhook: webhooks_url,redirect_uri: redirect_url,@@ -198,4 +198,12 @@ class Provider::Plaiddef get_additional_consented_products(accountable_type)MAYBE_SUPPORTED_PLAID_PRODUCTS - [ get_primary_product(accountable_type) ]end++ def get_country_codes(eu)+ if eu+ [ "ES", "NL", "FR", "IE", "DE", "IT", "PL", "DK", "NO", "SE", "EE", "LT", "LV", "PT", "BE" ] # EU supported countries+ else+ [ "US", "CA" ] # US + CA only+ end+ endenddiff --git a/app/views/accounts/new/_method_selector.html.erb b/app/views/accounts/new/_method_selector.html.erbindex 4c32ede4..0ec22cfd 100644--- a/app/views/accounts/new/_method_selector.html.erb+++ b/app/views/accounts/new/_method_selector.html.erb@@ -10,12 +10,23 @@<% end %><% if link_token.present? %>+ <%# Default US-only Link %><button data-controller="plaid" data-action="plaid#open modal#close" data-plaid-link-token-value="<%= @link_token %>" class="flex items-center gap-4 w-full text-center focus:outline-none focus:bg-gray-50 border border-transparent focus:border focus:border-gray-200 px-2 hover:bg-gray-50 rounded-lg p-2"><span class="flex w-8 h-8 shrink-0 grow-0 items-center justify-center rounded-lg bg-alpha-black-50 shadow-[inset_0_0_0_1px_rgba(0,0,0,0.02)]"><%= lucide_icon("link-2", class: "text-gray-500 w-5 h-5") %></span>- <%= t("accounts.new.method_selector.connected_entry") %>+ <%= t(".connected_entry") %></button>++ <%# EU Link %>+ <% unless Current.family.country == "US" %>+ <button data-controller="plaid" data-action="plaid#open modal#close" data-plaid-link-token-value="<%= Current.family.get_link_token(webhooks_url: webhooks_plaid_url, redirect_url: accounts_url, accountable_type: accountable_type.name, region: :eu) %>" class="flex items-center gap-4 w-full text-center focus:outline-none focus:bg-gray-50 border border-transparent focus:border focus:border-gray-200 px-2 hover:bg-gray-50 rounded-lg p-2">+ <span class="flex w-8 h-8 shrink-0 grow-0 items-center justify-center rounded-lg bg-alpha-black-50 shadow-[inset_0_0_0_1px_rgba(0,0,0,0.02)]">+ <%= lucide_icon("link-2", class: "text-gray-500 w-5 h-5") %>+ </span>+ <%= t(".connected_entry_eu") %>+ </button>+ <% end %><% end %></div><% end %>diff --git a/config/initializers/plaid.rb b/config/initializers/plaid.rbindex b0631110..1925158a 100644--- a/config/initializers/plaid.rb+++ b/config/initializers/plaid.rb@@ -1,5 +1,6 @@Rails.application.configure doconfig.plaid = nil+ config.plaid_eu = nilif ENV["PLAID_CLIENT_ID"].present? && ENV["PLAID_SECRET"].present?config.plaid = Plaid::Configuration.new@@ -7,4 +8,11 @@ Rails.application.configure doconfig.plaid.api_key["PLAID-CLIENT-ID"] = ENV["PLAID_CLIENT_ID"]config.plaid.api_key["PLAID-SECRET"] = ENV["PLAID_SECRET"]end++ if ENV["PLAID_EU_CLIENT_ID"].present? && ENV["PLAID_EU_SECRET"].present?+ config.plaid_eu = Plaid::Configuration.new+ config.plaid_eu.server_index = Plaid::Configuration::Environment[ENV["PLAID_ENV"] || "sandbox"]+ config.plaid_eu.api_key["PLAID-CLIENT-ID"] = ENV["PLAID_EU_CLIENT_ID"]+ config.plaid_eu.api_key["PLAID-SECRET"] = ENV["PLAID_EU_SECRET"]+ endenddiff --git a/config/locales/views/accounts/en.yml b/config/locales/views/accounts/en.ymlindex 9162acdd..61029610 100644--- a/config/locales/views/accounts/en.yml+++ b/config/locales/views/accounts/en.yml@@ -30,6 +30,7 @@ en:import_accounts: Import accountsmethod_selector:connected_entry: Link account+ connected_entry_eu: Link EU accountmanual_entry: Enter account balancetitle: How would you like to add it?title: What would you like to add?diff --git a/db/migrate/20241219151540_add_region_to_plaid_item.rb b/db/migrate/20241219151540_add_region_to_plaid_item.rbnew file mode 100644index 00000000..55e96075--- /dev/null+++ b/db/migrate/20241219151540_add_region_to_plaid_item.rb@@ -0,0 +1,5 @@+class AddRegionToPlaidItem < ActiveRecord::Migration[7.2]+ def change+ add_column :plaid_items, :plaid_region, :string, null: false, default: "us"+ end+enddiff --git a/db/schema.rb b/db/schema.rbindex 8efce7d1..4a507949 100644--- a/db/schema.rb+++ b/db/schema.rb@@ -516,6 +516,7 @@ ActiveRecord::Schema[7.2].define(version: 2025_01_31_171943) dot.string "available_products", default: [], array: truet.string "billed_products", default: [], array: truet.datetime "last_synced_at"+ t.string "plaid_region", default: "us", null: falset.index ["family_id"], name: "index_plaid_items_on_family_id"enddiff --git a/test/controllers/plaid_items_controller_test.rb b/test/controllers/plaid_items_controller_test.rbindex 7f9a3afe..78636757 100644--- a/test/controllers/plaid_items_controller_test.rb+++ b/test/controllers/plaid_items_controller_test.rb@@ -21,6 +21,7 @@ class PlaidItemsControllerTest < ActionDispatch::IntegrationTestpost plaid_items_url, params: {plaid_item: {public_token: public_token,+ region: "us",metadata: { institution: { name: "Plaid Item Name" } }}}diff --git a/test/models/plaid_item_test.rb b/test/models/plaid_item_test.rbindex e18b1785..8d680707 100644--- a/test/models/plaid_item_test.rb+++ b/test/models/plaid_item_test.rb@@ -9,9 +9,7 @@ class PlaidItemTest < ActiveSupport::TestCasetest "removes plaid item when destroyed" do@plaid_provider = mock-- PlaidItem.stubs(:plaid_provider).returns(@plaid_provider)-+ @plaid_item.stubs(:plaid_provider).returns(@plaid_provider)@plaid_provider.expects(:remove_item).with(@plaid_item.access_token).onceassert_difference "PlaidItem.count", -1 do@@ -21,9 +19,7 @@ class PlaidItemTest < ActiveSupport::TestCasetest "if plaid item not found, silently continues with deletion" do@plaid_provider = mock-- PlaidItem.stubs(:plaid_provider).returns(@plaid_provider)-+ @plaid_item.stubs(:plaid_provider).returns(@plaid_provider)@plaid_provider.expects(:remove_item).with(@plaid_item.access_token).raises(Plaid::ApiError.new("Item not found"))assert_difference "PlaidItem.count", -1 do