omniauth-v2-ynab

OmniAuth strategy for YNAB (You Need A Budget) OAuth2.

Compatible with omniauth 2.x, oauth2 2.x, and omniauth-rails_csrf_protection 1.x.

Note: This is a maintained fork of the original omniauth-ynab gem, updated for the omniauth 2.x / oauth2 2.x ecosystem. The version starts at 2.0.0 so that projects upgrading from omniauth-ynab can switch gems and bump to >= 2.0 without a version conflict.

Add to your Gemfile:

gem "omniauth-v2-ynab"
gem "omniauth-rails_csrf_protection" # required for Rails with omniauth 2.x

Then run:

bundle install

Create an OAuth application at app.youneedabudget.com/oauth/applications. Set the redirect URI to match your callback URL (e.g. https://yourapp.com/auth/ynab/callback).

In config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :ynab, ENV["YNAB_CLIENT_ID"], ENV["YNAB_CLIENT_SECRET"]
end

Add routes:

# config/routes.rb
get  "/auth/:provider/callback", to: "sessions#create"
get  "/auth/failure",            to: "sessions#failure"

Trigger the flow from a view using a CSRF-protected link (provided by omniauth-rails_csrf_protection):

<%= link_to "Connect YNAB", "/auth/ynab", method: :post %>

Handle the callback in your controller:

class SessionsController < ApplicationController
  def create
    auth = request.env["omniauth.auth"]
    token      = auth.credentials.token
    expires_at = auth.credentials.expires_at
    # store token and create/find the user ...
  end

  def failure
    # request.env["omniauth.error"] contains the error
  end
end

use OmniAuth::Builder do
  provider :ynab, ENV["YNAB_CLIENT_ID"], ENV["YNAB_CLIENT_SECRET"]
end

All options are passed as keyword arguments to provider.

provider :ynab, ENV["YNAB_CLIENT_ID"], ENV["YNAB_CLIENT_SECRET"], pkce: true

provider :ynab, "id", "secret",
  client_options: {site: "https://staging.example.com"}

After a successful callback, request.env["omniauth.auth"].credentials contains:

• Ruby 3.1+
• Bundler 2.x

git clone https://github.com/tataihono/omniauth-v2-ynab.git
cd omniauth-ynab
bundle install

bundle exec rspec

bundle exec rubocop

bundle exec rake

1. Fork the repo and create a branch from main.
2. Add tests for any new behaviour.
3. Ensure bundle exec rake passes.
4. Open a pull request.

MIT. See LICENSE.md for details.

Original gem by Mike Berkman.