discourse/plugins/discourse-patreon/lib/discourse_patreon/engine.rb
Rafael dos Santos Silva 8c0a4bb8f9
DEV: Upgrade Patreon plugin to API v2 with v1 backward compatibility (#38871)
## Summary

Patreon API v1 has been deprecated for years and the Patreon team has
requested we migrate to v2 (see
https://meta.discourse.org/t/upgrade-patreon-discourse-plugin-to-api-v2/386701).

Since hundreds of existing customers have v1 OAuth clients, this PR
supports **both versions simultaneously** via an adapter pattern,
controlled by a new `patreon_api_version` site setting (defaults to
`"1"` so no one breaks on upgrade).

### What changed

- **Adapter pattern**: `Patreon::ApiVersion::V1` and `ApiVersion::V2`
modules with identical interfaces for endpoints, response parsing, and
OAuth config. `ApiVersion.current` routes based on the site setting.
- **v2 API support**: campaigns endpoint returns tiers (not rewards),
members fetched separately with cursor-based pagination, v2 identity
endpoint with explicit field selection, v2 OAuth scopes
- **Webhooks accept both formats**: payload version detected from
`data.type` (`"pledge"` → v1, `"member"` → v2), regardless of the site
setting
- **Admin deprecation notice**: `ProblemCheck::PatreonApiV1Deprecated`
warns on the dashboard when still using v1
- **Shared logic unchanged**: rate limiting, PluginStore, group sync,
admin UI all version-agnostic
- Also fixes pre-existing flaky seed/campaign spec failures

### Migration path for existing users

1. Admin sees deprecation warning on dashboard
2. Create a new v2 OAuth client at
https://www.patreon.com/portal/registration/register-clients
3. Update credentials in site settings
4. Switch `patreon_api_version` to `"2"`
5. Creator re-authenticates via Patreon login to get v2-scoped tokens
6. Trigger a manual data sync from the Patreon admin panel

### Future v1 removal

When ready to drop v1: delete `lib/api_version/v1.rb`, the problem
check, the site setting, v1 fixtures, and v1 test contexts — one clean
cut.

## Test plan

- [x] All 41 plugin specs pass (both v1 and v2 contexts)
- [x] Lint passes on all changed files
- [x] Zeitwerk reload passes (`bin/rails runner
"Rails.application.reloader.reload!"`)
- [x] Manual testing with a real Patreon v2 OAuth client
2026-03-30 14:43:34 -03:00

53 lines
1 KiB
Ruby

# frozen_string_literal: true
module Patreon
USER_DETAIL_FIELDS = %w[id amount_cents rewards declined_since].freeze
module ApiVersion
def self.current
SiteSetting.patreon_api_version == "2" ? V2 : V1
end
def self.adapter_for_payload(data)
data.dig("data", "type") == "pledge" ? V1 : V2
end
end
class Engine < ::Rails::Engine
engine_name PLUGIN_NAME
isolate_namespace Patreon
end
def self.store
@store ||= PluginStore.new(PLUGIN_NAME)
end
def self.get(key)
store.get(key)
end
def self.set(key, value)
store.set(key, value)
end
def self.show_donation_prompt_to_user?(user)
return false unless SiteSetting.patreon_donation_prompt_enabled?
filters = get("filters") || {}
filters = filters.keys.map(&:to_i)
(user.visible_groups.pluck(:id) & filters).size <= 0
end
class Reward
def self.all
Patreon.get("rewards") || {}
end
end
class RewardUser
def self.all
Patreon.get("reward-users") || {}
end
end
end