mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-02 21:27:59 +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
50 lines
1.5 KiB
Ruby
50 lines
1.5 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require_relative "../spec_helper"
|
|
|
|
RSpec.describe Jobs::PatreonUpdateTokens do
|
|
before { SiteSetting.patreon_enabled = true }
|
|
|
|
shared_examples "token refresh" do
|
|
it "should update both access and refresh tokens from Patreon" do
|
|
described_class.new.execute({})
|
|
|
|
expect(SiteSetting.patreon_creator_access_token).to eq("ACCESS TOKEN")
|
|
expect(SiteSetting.patreon_creator_refresh_token).to eq("REFRESH TOKEN")
|
|
end
|
|
end
|
|
|
|
context "with API v1" do
|
|
before do
|
|
SiteSetting.patreon_api_version = "1"
|
|
|
|
stub_request(:post, "https://api.patreon.com/oauth2/token").with(
|
|
body: {
|
|
"client_id" => SiteSetting.patreon_client_id,
|
|
"client_secret" => SiteSetting.patreon_client_secret,
|
|
"grant_type" => "refresh_token",
|
|
"refresh_token" => SiteSetting.patreon_creator_refresh_token,
|
|
},
|
|
).to_return(status: 200, body: get_patreon_response("tokens.json"))
|
|
end
|
|
|
|
include_examples "token refresh"
|
|
end
|
|
|
|
context "with API v2" do
|
|
before do
|
|
SiteSetting.patreon_api_version = "2"
|
|
|
|
stub_request(:post, "https://www.patreon.com/api/oauth2/token").with(
|
|
body: {
|
|
"client_id" => SiteSetting.patreon_client_id,
|
|
"client_secret" => SiteSetting.patreon_client_secret,
|
|
"grant_type" => "refresh_token",
|
|
"refresh_token" => SiteSetting.patreon_creator_refresh_token,
|
|
},
|
|
).to_return(status: 200, body: get_patreon_response("tokens.json"))
|
|
end
|
|
|
|
include_examples "token refresh"
|
|
end
|
|
end
|
