mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-02 08:13:47 +08:00
8c0a4bb8f9
## 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
72 lines
1.9 KiB
Ruby
72 lines
1.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Patreon
|
|
class Pledge
|
|
def self.create!(data, adapter: ApiVersion.current)
|
|
save!([data], true, adapter: adapter)
|
|
end
|
|
|
|
def self.update!(data, adapter: ApiVersion.current)
|
|
delete!(data, adapter: adapter)
|
|
create!(data, adapter: adapter)
|
|
end
|
|
|
|
def self.delete!(data, adapter: ApiVersion.current)
|
|
entry = data["data"]
|
|
reward_users = Patreon::RewardUser.all
|
|
|
|
patron_id = adapter.delete_pledge_data(entry, reward_users)
|
|
|
|
Patreon.set("pledges", all.except(patron_id))
|
|
Decline.set(Decline.all.except(patron_id))
|
|
Patreon.set("users", Patreon::Patron.all.except(patron_id))
|
|
Patreon.set("reward-users", reward_users)
|
|
end
|
|
|
|
def self.save!(pledges_data, is_append = false, adapter: ApiVersion.current)
|
|
pledges = is_append ? all : {}
|
|
reward_users = is_append ? Patreon::RewardUser.all : {}
|
|
users = is_append ? Patreon::Patron.all : {}
|
|
declines = is_append ? Decline.all : {}
|
|
|
|
pledges_data.each do |pledge_data|
|
|
new_pledges, new_declines, new_reward_users, new_users = adapter.extract(pledge_data)
|
|
|
|
pledges.merge!(new_pledges)
|
|
declines.merge!(new_declines)
|
|
users.merge!(new_users)
|
|
|
|
Patreon::Reward.all.keys.each do |key|
|
|
reward_users[key] = (reward_users[key] || []) + (new_reward_users[key] || [])
|
|
end
|
|
end
|
|
|
|
reward_users["0"] = pledges.keys
|
|
|
|
Patreon.set("pledges", pledges)
|
|
Decline.set(declines)
|
|
Patreon.set("reward-users", reward_users)
|
|
Patreon.set("users", users)
|
|
end
|
|
|
|
def self.all
|
|
Patreon.get("pledges") || {}
|
|
end
|
|
|
|
def self.get_patreon_id(data, adapter: ApiVersion.adapter_for_payload(data))
|
|
adapter.get_patreon_id(data)
|
|
end
|
|
|
|
class Decline
|
|
KEY = "pledge-declines"
|
|
|
|
def self.all
|
|
Patreon.get(KEY) || {}
|
|
end
|
|
|
|
def self.set(value)
|
|
Patreon.set(KEY, value)
|
|
end
|
|
end
|
|
end
|
|
end
|
