Basic Plaid Integration (#1433)

* Basic plaid data model and linking

* Remove institutions, add plaid items

* Improve schema and Plaid provider

* Add webhook verification sketch

* Webhook verification

* Item accounts and balances sync setup

* Provide test encryption keys

* Fix test

* Only provide encryption keys in prod

* Try defining keys in test env

* Consolidate account sync logic

* Add back plaid account initialization

* Plaid transaction sync

* Sync UI overhaul for Plaid

* Add liability and investment syncing

* Handle investment webhooks and process current day holdings

* Remove logs

* Remove "all" period select for performance

* fix amount calc

* Remove todo comment

* Coming soon for investment historical data

* Document Plaid configuration

* Listen for holding updates

Author: zachgoll

.env.example

@@ -110,4 +110,12 @@ GITHUB_REPO_BRANCH=main
 #
 STRIPE_PUBLISHABLE_KEY=
 STRIPE_SECRET_KEY=
-STRIPE_WEBHOOK_SECRET=
+STRIPE_WEBHOOK_SECRET=
+
+# ======================================================================================================
+# Plaid Configuration
+# ======================================================================================================
+#
+PLAID_CLIENT_ID=
+PLAID_SECRET=
+PLAID_ENV=

Gemfile

@@ -37,6 +37,7 @@ gem "image_processing", ">= 1.2"
 
 # Other
 gem "bcrypt", "~> 3.1"
+gem "jwt"
 gem "faraday"
 gem "faraday-retry"
 gem "faraday-multipart"
@@ -50,6 +51,7 @@ gem "redcarpet"
 gem "stripe"
 gem "intercom-rails"
 gem "holidays"
+gem "plaid"
 
 group :development, :test do
   gem "debug", platforms: %i[mri windows]

Gemfile.lock

@@ -224,6 +224,8 @@ GEM
       reline (>= 0.4.2)
     jmespath (1.6.2)
     json (2.7.2)
+    jwt (2.9.3)
+      base64
     language_server-protocol (3.17.0.3)
     launchy (3.0.1)
       addressable (~> 2.8)
@@ -284,6 +286,9 @@ GEM
       ast (~> 2.4.1)
       racc
     pg (1.5.9)
+    plaid (33.0.0)
+      faraday (>= 1.0.1, < 3.0)
+      faraday-multipart (>= 1.0.1, < 2.0)
     prism (1.2.0)
     propshaft (1.1.0)
       actionpack (>= 7.0.0)
@@ -495,12 +500,14 @@ DEPENDENCIES
   importmap-rails
   inline_svg
   intercom-rails
+  jwt
   letter_opener
   lucide-rails!
   mocha
   octokit
   pagy
   pg (~> 1.5)
+  plaid
   propshaft
   puma (>= 5.0)
   rails (~> 7.2.2)

app/assets/images/placeholder-graph.svg

@@ -101,7 +101,7 @@
   }
 
   .btn {
-    @apply px-3 py-2 rounded-lg text-sm font-medium cursor-pointer focus:outline-gray-500;
+    @apply px-3 py-2 rounded-lg text-sm font-medium cursor-pointer disabled:cursor-not-allowed focus:outline-gray-500;
   }
 
   .btn--primary {
@@ -113,7 +113,7 @@
   }
 
   .btn--outline {
-    @apply border border-alpha-black-200 text-gray-900 hover:bg-gray-50;
+    @apply border border-alpha-black-200 text-gray-900 hover:bg-gray-50 disabled:bg-gray-50 disabled:hover:bg-gray-50 disabled:text-gray-400;
   }
 
   .btn--ghost {

app/assets/stylesheets/application.tailwind.css

@@ -4,8 +4,8 @@ class AccountsController < ApplicationController
   before_action :set_account, only: %i[sync]
 
   def index
-    @institutions = Current.family.institutions
-    @accounts = Current.family.accounts.ungrouped.alphabetically
+    @manual_accounts = Current.family.accounts.manual.active.alphabetically
+    @plaid_items = Current.family.plaid_items.active.ordered
   end
 
   def summary
@@ -27,11 +27,16 @@ def sync
     unless @account.syncing?
       @account.sync_later
     end
+
+    redirect_to account_path(@account)
   end
 
   def sync_all
-    Current.family.accounts.active.sync
-    redirect_back_or_to accounts_path, notice: t(".success")
+    unless Current.family.syncing?
+      Current.family.sync_later
+    end
+
+    redirect_to accounts_path
   end
 
   private

app/controllers/accounts_controller.rb

@@ -4,6 +4,7 @@ module AccountableResource
   included do
     layout :with_sidebar
     before_action :set_account, only: [ :show, :edit, :update, :destroy ]
+    before_action :set_link_token, only: :new
   end
 
   class_methods do
@@ -16,8 +17,7 @@ def permitted_accountable_attributes(*attrs)
   def new
     @account = Current.family.accounts.build(
       currency: Current.family.currency,
-      accountable: accountable_type.new,
-      institution_id: params[:institution_id]
+      accountable: accountable_type.new
     )
   end
 
@@ -29,20 +29,35 @@ def edit
 
   def create
     @account = Current.family.accounts.create_and_sync(account_params.except(:return_to))
-    redirect_to account_params[:return_to].presence || @account, notice: t(".success")
+    redirect_to account_params[:return_to].presence || @account, notice: t("accounts.create.success", type: accountable_type.name.underscore.humanize)
   end
 
   def update
     @account.update_with_sync!(account_params.except(:return_to))
-    redirect_back_or_to @account, notice: t(".success")
+    redirect_back_or_to @account, notice: t("accounts.update.success", type: accountable_type.name.underscore.humanize)
   end
 
   def destroy
-    @account.destroy!
-    redirect_to accounts_path, notice: t(".success")
+    @account.destroy_later
+    redirect_to accounts_path, notice: t("accounts.destroy.success", type: accountable_type.name.underscore.humanize)
   end
 
   private
+    def set_link_token
+      @link_token = Current.family.get_link_token(
+        webhooks_url: webhooks_url,
+        redirect_url: accounts_url,
+        accountable_type: accountable_type.name
+      )
+    end
+
+    def webhooks_url
+      return webhooks_plaid_url if Rails.env.production?
+
+      base_url = ENV.fetch("DEV_WEBHOOKS_URL", root_url.chomp("/"))
+      base_url + "/webhooks/plaid"
+    end
+
     def accountable_type
       controller_name.classify.constantize
     end
@@ -53,7 +68,7 @@ def set_account
 
     def account_params
       params.require(:account).permit(
-        :name, :is_active, :balance, :subtype, :currency, :institution_id, :accountable_type, :return_to,
+        :name, :is_active, :balance, :subtype, :currency, :accountable_type, :return_to,
         accountable_attributes: self.class.permitted_accountable_attributes
       )
     end

app/controllers/concerns/accountable_resource.rb

@@ -2,12 +2,20 @@ module AutoSync
   extend ActiveSupport::Concern
 
   included do
-    before_action :sync_family, if: -> { Current.family.present? && Current.family.needs_sync? }
+    before_action :sync_family, if: :family_needs_auto_sync?
   end
 
   private
-
     def sync_family
-      Current.family.sync
+      Current.family.update!(last_synced_at: Time.current)
+      Current.family.sync_later
+    end
+
+    def family_needs_auto_sync?
+      return false unless Current.family.present?
+      return false unless Current.family.accounts.any?
+
+      Current.family.last_synced_at.blank? ||
+      Current.family.last_synced_at.to_date < Date.current
     end
 end

app/controllers/concerns/auto_sync.rb

@@ -0,0 +1,38 @@
+class PlaidItemsController < ApplicationController
+  before_action :set_plaid_item, only: %i[destroy sync]
+
+  def create
+    Current.family.plaid_items.create_from_public_token(
+      plaid_item_params[:public_token],
+      item_name: item_name,
+    )
+
+    redirect_to accounts_path, notice: t(".success")
+  end
+
+  def destroy
+    @plaid_item.destroy_later
+    redirect_to accounts_path, notice: t(".success")
+  end
+
+  def sync
+    unless @plaid_item.syncing?
+      @plaid_item.sync_later
+    end
+
+    redirect_to accounts_path
+  end
+
+  private
+    def set_plaid_item
+      @plaid_item = Current.family.plaid_items.find(params[:id])
+    end
+
+    def plaid_item_params
+      params.require(:plaid_item).permit(:public_token, metadata: {})
+    end
+
+    def item_name
+      plaid_item_params.dig(:metadata, :institution, :name)
+    end
+end