A platform for community discussion. Free, open, simple.
DEV: Upgrade Patreon plugin to API v2 with v1 backward compatibility (#38871)
Rafael dos Santos Silva8c0a4bb8f95c
diff --git a/plugins/discourse-patreon/app/controllers/patreon/patreon_webhook_controller.rb b/plugins/discourse-patreon/app/controllers/patreon/patreon_webhook_controller.rbindex ce477202efe..26c5eb0bf6e 100644--- a/plugins/discourse-patreon/app/controllers/patreon/patreon_webhook_controller.rb+++ b/plugins/discourse-patreon/app/controllers/patreon/patreon_webhook_controller.rb@@ -15,10 +15,13 @@ class Patreon::PatreonWebhookController < ApplicationControllerpledges:createpledges:updatepledges:delete+ members:create+ members:update+ members:deletemembers:pledge:createmembers:pledge:updatemembers:pledge:delete- ]+ ].freezedef indexif unknown_trigger?@@ -37,7 +40,8 @@ class Patreon::PatreonWebhookController < ApplicationControllerendpledge_data = JSON.parse(request.body.read)- patreon_id = Patreon::Pledge.get_patreon_id(pledge_data)+ adapter = Patreon::ApiVersion.adapter_for_payload(pledge_data)+ patreon_id = Patreon::Pledge.get_patreon_id(pledge_data, adapter: adapter)if SiteSetting.patreon_verbose_logRails.logger.warn(@@ -46,12 +50,12 @@ class Patreon::PatreonWebhookController < ApplicationControllerendcase event- when "pledges:create", "members:pledge:create"- Patreon::Pledge.create!(pledge_data)- when "pledges:update", "members:pledge:update"- Patreon::Pledge.update!(pledge_data)- when "pledges:delete", "members:pledge:delete"- Patreon::Pledge.delete!(pledge_data)+ when /create$/+ Patreon::Pledge.create!(pledge_data, adapter: adapter)+ when /update$/+ Patreon::Pledge.update!(pledge_data, adapter: adapter)+ when /delete$/+ Patreon::Pledge.delete!(pledge_data, adapter: adapter)endJobs.enqueue(:sync_patron_groups, patreon_id: patreon_id)diff --git a/plugins/discourse-patreon/app/services/problem_check/patreon_api_v1_deprecated.rb b/plugins/discourse-patreon/app/services/problem_check/patreon_api_v1_deprecated.rbnew file mode 100644index 00000000000..08e0f27ae35--- /dev/null+++ b/plugins/discourse-patreon/app/services/problem_check/patreon_api_v1_deprecated.rb@@ -0,0 +1,11 @@+# frozen_string_literal: true++class ProblemCheck::PatreonApiV1Deprecated < ProblemCheck+ self.priority = "low"++ def call+ return no_problem if !SiteSetting.patreon_enabled?+ return no_problem if SiteSetting.patreon_api_version != "1"+ problem+ end+enddiff --git a/plugins/discourse-patreon/config/locales/server.en.yml b/plugins/discourse-patreon/config/locales/server.en.ymlindex b09dd60ad06..2fa24068155 100644--- a/plugins/discourse-patreon/config/locales/server.en.yml+++ b/plugins/discourse-patreon/config/locales/server.en.yml@@ -14,12 +14,14 @@ en:patreon_verbose_log: 'enable verbose logging of patreon payload'patreon_donation_prompt_enabled: "Enable donation prompt?"patreon_donation_prompt_show_after_topics: "Show donation prompt after n topics"+ patreon_api_version: "Patreon API version. Version 1 is deprecated — create a new OAuth client on Patreon and switch to version 2."patreon_donation_prompt_campaign_url: "Donation prompt campaign URL"errors:patreon_creator_username_not_set: "You need to set the Patreon Creator Discourse Username setting before enabling Patreon Login."dashboard:problem:access_token_invalid: "Patreon Creator's access and refresh token values are incorrect. You must copy-paste new tokens from <a href='https://www.patreon.com/platform/documentation/clients'>Patreon website</a> to <a href='%{base_path}/admin/site_settings/category/all_results?filter=patreon'>site settings</a>."+ patreon_api_v1_deprecated: "You are using Patreon API v1, which is deprecated. Please <a href='https://www.patreon.com/portal/registration/register-clients'>create a new v2 OAuth client on Patreon</a>, update your credentials, and switch to API v2 in <a href='%{base_path}/admin/site_settings/category/all_results?filter=patreon_api_version'>site settings</a>."patreon:error:invalid_response: "Invalid response from Patreon API"diff --git a/plugins/discourse-patreon/config/settings.yml b/plugins/discourse-patreon/config/settings.ymlindex 125c391f032..a16a304fecd 100644--- a/plugins/discourse-patreon/config/settings.yml+++ b/plugins/discourse-patreon/config/settings.yml@@ -6,6 +6,12 @@ discourse_patreon:default: falseclient: truevalidator: 'PatreonLoginEnabledValidator'+ patreon_api_version:+ default: "1"+ type: enum+ choices:+ - "1"+ - "2"patreon_client_id:default: ''patreon_client_secret:diff --git a/plugins/discourse-patreon/lib/api.rb b/plugins/discourse-patreon/lib/api.rbindex 12d3b5d1b9e..ed5abec2d01 100644--- a/plugins/discourse-patreon/lib/api.rb+++ b/plugins/discourse-patreon/lib/api.rb@@ -11,12 +11,11 @@ module PatreonINVALID_RESPONSE = "patreon.error.invalid_response"def self.campaign_data- get(- "/oauth2/api/current_user/campaigns?include=rewards,creator,goals,pledges&page[count]=100",- )+ adapter = ApiVersion.current+ get(adapter.campaign_data_url, base_url: adapter.api_base_url)end- def self.get(uri)+ def self.get(uri, base_url: ApiVersion.current.api_base_url)limiter_hr =RateLimiter.new(nil, "patreon_api_hr", SiteSetting.max_patreon_api_reqs_per_hr, 1.hour)limiter_day =@@ -26,17 +25,27 @@ module Patreonlimiter_day.performed! unless limiter_day.can_perform?+ full_url = "#{base_url}#{uri}"+ Rails.logger.warn("Patreon API request: GET #{full_url}") if SiteSetting.patreon_verbose_log+response =Faraday.new(- url: "https://api.patreon.com",+ url: base_url,headers: {"Authorization" => "Bearer #{SiteSetting.patreon_creator_access_token}",+ "User-Agent" => "Discourse Patreon Plugin/#{Discourse::VERSION::STRING}",},).get(uri)limiter_hr.performed!limiter_day.performed!+ if SiteSetting.patreon_verbose_log+ Rails.logger.warn(+ "Patreon API response: status=#{response.status} body_size=#{response.body&.size || 0}",+ )+ end+case response.statuswhen 200return JSON.parse response.bodydiff --git a/plugins/discourse-patreon/lib/api_version/v1.rb b/plugins/discourse-patreon/lib/api_version/v1.rbnew file mode 100644index 00000000000..0b7c9c56005--- /dev/null+++ b/plugins/discourse-patreon/lib/api_version/v1.rb@@ -0,0 +1,156 @@+# frozen_string_literal: true++module Patreon+ module ApiVersion+ module V1+ BASE_URL = "https://api.patreon.com"++ def self.campaign_data_url+ "/oauth2/api/current_user/campaigns?include=rewards,creator,goals,pledges&page[count]=100"+ end++ def self.api_base_url+ BASE_URL+ end++ def self.token_base_url+ BASE_URL+ end++ def self.token_path+ "/oauth2/token"+ end++ def self.oauth_token_url+ "#{BASE_URL}/oauth2/token"+ end++ def self.oauth_authorize_params+ { response_type: "code" }+ end++ def self.oauth_identity_url+ "#{BASE_URL}/oauth2/api/current_user"+ end++ def self.parse_campaigns(response)+ rewards = {}+ campaign_rewards = []+ pledge_uris = []++ response["data"].each do |campaign|+ uri = campaign["relationships"]["pledges"]["links"]["first"]+ pledge_uris << uri.sub("page%5Bcount%5D=20", "page%5Bcount%5D=100")++ campaign["relationships"]["rewards"]["data"].each do |entry|+ campaign_rewards << entry["id"]+ end+ end++ response["included"].each do |entry|+ id = entry["id"]+ if entry["type"] == "reward" && campaign_rewards.include?(id)+ rewards[id] = entry["attributes"]+ rewards[id]["id"] = id+ end+ end++ { rewards: rewards, pledge_uris: pledge_uris }+ end++ def self.pull_pledges!(campaign_data)+ uris = campaign_data[:pledge_uris].dup+ pledges_data = []++ uris.each do |uri|+ pledge_data = Patreon::Api.get(uri)++ if pledge_data["links"] && pledge_data["links"]["next"]+ next_page_uri = pledge_data["links"]["next"]+ uris << next_page_uri if next_page_uri.present?+ end++ pledges_data << pledge_data if pledge_data.present?+ end++ Patreon::Pledge.save!(pledges_data, adapter: self)+ end++ def self.extract(pledge_data)+ pledges, declines, reward_users, users = {}, {}, {}, {}++ if pledge_data && pledge_data["data"].present?+ pledge_data["data"] = [pledge_data["data"]] unless pledge_data["data"].kind_of?(Array)++ pledge_data["data"].each do |entry|+ if entry["type"] == "pledge"+ patron_id = entry["relationships"]["patron"]["data"]["id"]+ attrs = entry["attributes"]++ unless entry["relationships"]["reward"]["data"].nil?+ (reward_users[entry["relationships"]["reward"]["data"]["id"]] ||= []) << patron_id+ end+ pledges[patron_id] = attrs["amount_cents"]+ declines[patron_id] = attrs["declined_since"] if attrs["declined_since"].present?+ elsif entry["type"] == "member"+ patron_id = entry["relationships"]["user"]["data"]["id"]+ attrs = entry["attributes"]++ currently_entitled_tiers = entry["relationships"]["currently_entitled_tiers"] || {}+ (currently_entitled_tiers["data"] || []).each do |tier|+ (reward_users[tier["id"]] ||= []) << patron_id+ end+ pledges[patron_id] = attrs["pledge_amount_cents"]+ declines[patron_id] = attrs["last_charge_date"] if attrs["last_charge_status"] ==+ "Declined"+ end+ end++ pledge_data["included"]&.each do |entry|+ if entry["type"] == "user" && entry["attributes"]["email"].present?+ users[entry["id"]] = entry["attributes"]["email"].downcase+ end+ end+ end++ [pledges, declines, reward_users, users]+ end++ def self.delete_pledge_data(entry, reward_users)+ rel = entry["relationships"]++ if entry["type"] == "pledge"+ patron_id = rel["patron"]["data"]["id"]+ reward_id = rel["reward"]["data"]["id"] if rel["reward"]["data"].present?++ reward_users[reward_id].reject! { |i| i == patron_id } if reward_id.present?+ elsif entry["type"] == "member"+ patron_id = rel["user"]["data"]["id"]++ (rel.dig("currently_entitled_tiers", "data") || []).each do |tier|+ (reward_users[tier["id"]] || []).reject! { |i| i == patron_id }+ end+ end++ patron_id+ end++ def self.get_patreon_id(data)+ entry = data["data"]+ key = entry["type"] == "member" ? "user" : "patron"+ entry["relationships"][key]["data"]["id"]+ end++ def self.webhook_triggers+ %w[+ pledges:create+ pledges:update+ pledges:delete+ members:pledge:create+ members:pledge:update+ members:pledge:delete+ ]+ end+ end+ end+enddiff --git a/plugins/discourse-patreon/lib/api_version/v2.rb b/plugins/discourse-patreon/lib/api_version/v2.rbnew file mode 100644index 00000000000..e1ca4c551bb--- /dev/null+++ b/plugins/discourse-patreon/lib/api_version/v2.rb@@ -0,0 +1,146 @@+# frozen_string_literal: true++module Patreon+ module ApiVersion+ module V2+ BASE_URL = "https://www.patreon.com"++ CAMPAIGN_FIELDS = "fields%5Bcampaign%5D=created_at,name,patron_count"+ TIER_FIELDS = "fields%5Btier%5D=title,amount_cents,created_at"+ MEMBER_FIELDS =+ "fields%5Bmember%5D=full_name,last_charge_date,last_charge_status,currently_entitled_amount_cents,patron_status,email"+ USER_FIELDS = "fields%5Buser%5D=email,full_name"++ def self.campaign_data_url+ "/api/oauth2/v2/campaigns?include=tiers,creator&#{CAMPAIGN_FIELDS}&#{TIER_FIELDS}"+ end++ def self.api_base_url+ BASE_URL+ end++ def self.token_base_url+ BASE_URL+ end++ def self.token_path+ "/api/oauth2/token"+ end++ def self.oauth_token_url+ "#{BASE_URL}/api/oauth2/token"+ end++ def self.oauth_authorize_params+ {+ response_type: "code",+ scope: "identity identity[email] campaigns campaigns.members campaigns.members[email]",+ }+ end++ def self.oauth_identity_url+ "#{BASE_URL}/api/oauth2/v2/identity?fields%5Buser%5D=email,full_name,is_email_verified"+ end++ def self.members_data_url(campaign_id, cursor = nil)+ url =+ "/api/oauth2/v2/campaigns/#{campaign_id}/members?include=currently_entitled_tiers,user&#{MEMBER_FIELDS}&#{USER_FIELDS}&#{TIER_FIELDS}&page%5Bcount%5D=1000"+ url += "&page%5Bcursor%5D=#{CGI.escape(cursor)}" if cursor.present?+ url+ end++ def self.parse_campaigns(response)+ rewards = {}++ campaign_ids = response["data"].map { |campaign| campaign["id"] }++ (response["included"] || []).each do |entry|+ if entry["type"] == "tier"+ id = entry["id"]+ rewards[id] = entry["attributes"]+ rewards[id]["id"] = id+ end+ end++ { rewards: rewards, campaign_ids: campaign_ids }+ end++ def self.pull_pledges!(campaign_data)+ campaign_ids = campaign_data[:campaign_ids]+ members_data = []++ campaign_ids.each do |campaign_id|+ cursor = nil+ loop do+ response = Patreon::Api.get(members_data_url(campaign_id, cursor))+ break if response.blank? || response["data"].blank?++ members_data << response++ cursor = response.dig("meta", "pagination", "cursors", "next")+ break if cursor.blank?+ end+ end++ Patreon::Pledge.save!(members_data, adapter: self)+ end++ def self.extract(member_data)+ pledges, declines, reward_users, users = {}, {}, {}, {}++ if member_data && member_data["data"].present?+ member_data["data"] = [member_data["data"]] unless member_data["data"].kind_of?(Array)++ member_data["data"].each do |entry|+ next unless entry["type"] == "member"++ patron_id = entry["relationships"]["user"]["data"]["id"]+ attrs = entry["attributes"]++ (entry.dig("relationships", "currently_entitled_tiers", "data") || []).each do |tier|+ (reward_users[tier["id"]] ||= []) << patron_id+ end++ pledges[patron_id] = attrs["currently_entitled_amount_cents"]+ declines[patron_id] = attrs["last_charge_date"] if attrs["last_charge_status"] ==+ "Declined"+ end++ (member_data["included"] || []).each do |entry|+ if entry["type"] == "user" && entry["attributes"]["email"].present?+ users[entry["id"]] = entry["attributes"]["email"].downcase+ end+ end+ end++ [pledges, declines, reward_users, users]+ end++ def self.delete_pledge_data(entry, reward_users)+ rel = entry["relationships"]+ patron_id = rel["user"]["data"]["id"]++ (rel.dig("currently_entitled_tiers", "data") || []).each do |tier|+ (reward_users[tier["id"]] || []).reject! { |i| i == patron_id }+ end++ patron_id+ end++ def self.get_patreon_id(data)+ data["data"]["relationships"]["user"]["data"]["id"]+ end++ def self.webhook_triggers+ %w[+ members:create+ members:update+ members:delete+ members:pledge:create+ members:pledge:update+ members:pledge:delete+ ]+ end+ end+ end+enddiff --git a/plugins/discourse-patreon/lib/campaign.rb b/plugins/discourse-patreon/lib/campaign.rbindex 2ae6ae3369b..a0a315a9af1 100644--- a/plugins/discourse-patreon/lib/campaign.rb+++ b/plugins/discourse-patreon/lib/campaign.rb@@ -5,29 +5,27 @@ require "json"module Patreonclass Campaigndef self.update!- rewards = {}- campaign_rewards = []- pledges_uris = []+ verbose = SiteSetting.patreon_verbose_log+ adapter = ApiVersion.current- response = Patreon::Api.campaign_data-- return false if response.blank? || response["data"].blank?+ if verbose+ Rails.logger.warn("Patreon sync started using API v#{SiteSetting.patreon_api_version}")+ end- response["data"].map do |campaign|- uri = campaign["relationships"]["pledges"]["links"]["first"]- pledges_uris << uri.sub("page%5Bcount%5D=20", "page%5Bcount%5D=100")+ response = Patreon::Api.campaign_data- campaign["relationships"]["rewards"]["data"].each do |entry|- campaign_rewards << entry["id"]- end+ if response.blank? || response["data"].blank?+ Rails.logger.warn("Patreon sync: no campaign data returned") if verbose+ return falseend- response["included"].each do |entry|- id = entry["id"]- if entry["type"] == "reward" && campaign_rewards.include?(id)- rewards[id] = entry["attributes"]- rewards[id]["id"] = id- end+ campaign_data = adapter.parse_campaigns(response)+ rewards = campaign_data[:rewards]++ if verbose+ Rails.logger.warn(+ "Patreon sync: found #{rewards.size} rewards/tiers across #{response["data"].size} campaigns",+ )end# Special catch all patrons virtual reward@@ -37,7 +35,15 @@ module PatreonPatreon.set("rewards", rewards)- Patreon::Pledge.pull!(pledges_uris)+ adapter.pull_pledges!(campaign_data)++ pledges = Patreon.get("pledges") || {}+ users = Patreon.get("users") || {}+ if verbose+ Rails.logger.warn(+ "Patreon sync complete: #{pledges.size} pledges, #{users.size} users synced",+ )+ end# Sets all patrons to the seed group by default on first runfilters = Patreon.get("filters")diff --git a/plugins/discourse-patreon/lib/discourse_patreon/engine.rb b/plugins/discourse-patreon/lib/discourse_patreon/engine.rbindex a6cd15d22aa..2a5e07b828e 100644--- a/plugins/discourse-patreon/lib/discourse_patreon/engine.rb+++ b/plugins/discourse-patreon/lib/discourse_patreon/engine.rb@@ -3,6 +3,16 @@module PatreonUSER_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::Engineengine_name PLUGIN_NAMEisolate_namespace Patreondiff --git a/plugins/discourse-patreon/lib/pledge.rb b/plugins/discourse-patreon/lib/pledge.rbindex 26ede9ca55b..b35c3158160 100644--- a/plugins/discourse-patreon/lib/pledge.rb+++ b/plugins/discourse-patreon/lib/pledge.rb@@ -2,32 +2,20 @@module Patreonclass Pledge- def self.create!(pledge_data)- save!([pledge_data], true)+ def self.create!(data, adapter: ApiVersion.current)+ save!([data], true, adapter: adapter)end- def self.update!(pledge_data)- delete!(pledge_data)- create!(pledge_data)+ def self.update!(data, adapter: ApiVersion.current)+ delete!(data, adapter: adapter)+ create!(data, adapter: adapter)end- def self.delete!(pledge_data)- entry = pledge_data["data"]- rel = entry["relationships"]+ def self.delete!(data, adapter: ApiVersion.current)+ entry = data["data"]reward_users = Patreon::RewardUser.all- if entry["type"] == "pledge"- patron_id = rel["patron"]["data"]["id"]- reward_id = rel["reward"]["data"]["id"] if rel["reward"]["data"].present?-- reward_users[reward_id].reject! { |i| i == patron_id } if reward_id.present?- elsif entry["type"] == "member"- patron_id = rel["user"]["data"]["id"]-- (rel["currently_entitled_tiers"]["data"] || []).each do |tier|- (reward_users[tier["id"]] || []).reject! { |i| i == patron_id }- end- end+ patron_id = adapter.delete_pledge_data(entry, reward_users)Patreon.set("pledges", all.except(patron_id))Decline.set(Decline.all.except(patron_id))@@ -35,32 +23,14 @@ module PatreonPatreon.set("reward-users", reward_users)end- def self.pull!(uris)- pledges_data = []-- uris.each do |uri|- pledge_data = Patreon::Api.get(uri)-- # get next page if necessary and add to the current loop- if pledge_data["links"] && pledge_data["links"]["next"]- next_page_uri = pledge_data["links"]["next"]- uris << next_page_uri if next_page_uri.present?- end-- pledges_data << pledge_data if pledge_data.present?- end-- save!(pledges_data)- end-- def self.save!(pledges_data, is_append = false)+ 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 = extract(pledge_data)+ new_pledges, new_declines, new_reward_users, new_users = adapter.extract(pledge_data)pledges.merge!(new_pledges)declines.merge!(new_declines)@@ -79,59 +49,12 @@ module PatreonPatreon.set("users", users)end- def self.extract(pledge_data)- pledges, declines, reward_users, users = {}, {}, {}, {}-- if pledge_data && pledge_data["data"].present?- pledge_data["data"] = [pledge_data["data"]] unless pledge_data["data"].kind_of?(Array)-- # get pledges info- pledge_data["data"].each do |entry|- if entry["type"] == "pledge"- patron_id = entry["relationships"]["patron"]["data"]["id"]- attrs = entry["attributes"]-- (- reward_users[entry["relationships"]["reward"]["data"]["id"]] ||= []- ) << patron_id unless entry["relationships"]["reward"]["data"].nil?- pledges[patron_id] = attrs["amount_cents"]- declines[patron_id] = attrs["declined_since"] if attrs["declined_since"].present?- elsif entry["type"] == "member"- patron_id = entry["relationships"]["user"]["data"]["id"]- attrs = entry["attributes"]-- currently_entitled_tiers = entry["relationships"]["currently_entitled_tiers"] || {}- (currently_entitled_tiers["data"] || []).each do |tier|- (reward_users[tier["id"]] ||= []) << patron_id- end- pledges[patron_id] = attrs["pledge_amount_cents"]- declines[patron_id] = attrs["last_charge_date"] if attrs["last_charge_status"] ==- "Declined"- end- end-- # get user list too- pledge_data["included"].each do |entry|- case entry["type"]- when "user"- if entry["attributes"]["email"].present?- users[entry["id"]] = entry["attributes"]["email"].downcase- end- end- end- end-- [pledges, declines, reward_users, users]- end-def self.allPatreon.get("pledges") || {}end- def self.get_patreon_id(pledge_data)- data = pledge_data["data"]- key = data["type"] == "member" ? "user" : "patron"- data["relationships"][key]["data"]["id"]+ def self.get_patreon_id(data, adapter: ApiVersion.adapter_for_payload(data))+ adapter.get_patreon_id(data)endclass Declinediff --git a/plugins/discourse-patreon/lib/tokens.rb b/plugins/discourse-patreon/lib/tokens.rbindex f9e5160a29f..e4b8690f281 100644--- a/plugins/discourse-patreon/lib/tokens.rb+++ b/plugins/discourse-patreon/lib/tokens.rb@@ -5,11 +5,12 @@ require "json"module Patreonclass Tokensdef self.update!- conn = Faraday.new(url: "https://api.patreon.com")+ adapter = ApiVersion.current+ conn = Faraday.new(url: adapter.token_base_url)response =conn.post(- "/oauth2/token",+ adapter.token_path,grant_type: "refresh_token",refresh_token: SiteSetting.patreon_creator_refresh_token,client_id: SiteSetting.patreon_client_id,diff --git a/plugins/discourse-patreon/plugin.rb b/plugins/discourse-patreon/plugin.rbindex d93742bd69f..03098a1d4c5 100644--- a/plugins/discourse-patreon/plugin.rb+++ b/plugins/discourse-patreon/plugin.rb@@ -28,13 +28,16 @@ require_relative "lib/discourse_patreon/engine"after_initialize dorequire_dependency "admin_constraint"+ require_relative "lib/api_version/v1"+ require_relative "lib/api_version/v2"+ require_relative "lib/api"require_relative "app/controllers/patreon/patreon_admin_controller"require_relative "app/controllers/patreon/patreon_webhook_controller"require_relative "app/jobs/regular/sync_patron_groups"require_relative "app/jobs/scheduled/patreon_sync_patrons_to_groups"require_relative "app/jobs/scheduled/patreon_update_tokens"require_relative "app/services/problem_check/access_token_invalid"- require_relative "lib/api"+ require_relative "app/services/problem_check/patreon_api_v1_deprecated"require_relative "lib/seed"require_relative "lib/campaign"require_relative "lib/pledge"@@ -99,6 +102,7 @@ after_initialize doendregister_problem_check ProblemCheck::AccessTokenInvalid+ register_problem_check ProblemCheck::PatreonApiV1Deprecatedend# Authentication with Patreon@@ -137,7 +141,7 @@ class ::OmniAuth::Strategies::Patreon < ::OmniAuth::Strategies::OAuth2response =client.request(:get,- "https://api.patreon.com/oauth2/api/current_user",+ Patreon::ApiVersion.current.oauth_identity_url,headers: {"Authorization" => "Bearer #{access_token.token}",},@@ -162,6 +166,7 @@ class Auth::PatreonAuthenticator < Auth::ManagedAuthenticatorsetup:lambda { |env|strategy = env["omniauth.strategy"]+ adapter = Patreon::ApiVersion.currentstrategy.options[:client_id] = SiteSetting.patreon_client_idstrategy.options[:client_secret] = SiteSetting.patreon_client_secretstrategy.options[@@ -170,6 +175,8 @@ class Auth::PatreonAuthenticator < Auth::ManagedAuthenticatorstrategy.options[:provider_ignores_state] = SiteSetting.patreon_login_ignore_state+ strategy.options[:client_options][:token_url] = adapter.oauth_token_url+ strategy.options[:authorize_params] = adapter.oauth_authorize_params}enddiff --git a/plugins/discourse-patreon/spec/fixtures/campaigns.json b/plugins/discourse-patreon/spec/fixtures/campaigns.jsonindex c2b6b99f03d..423134f0271 100644--- a/plugins/discourse-patreon/spec/fixtures/campaigns.json+++ b/plugins/discourse-patreon/spec/fixtures/campaigns.json@@ -2,30 +2,8 @@"data": [{"attributes": {"created_at": "2017-10-20T21:39:01+00:00",- "creation_count": 0,- "creation_name": "Documentation",- "discord_server_id": null,- "display_patron_goals": false,- "earnings_visibility": "public",- "image_small_url": null,- "image_url": null,- "is_charged_immediately": false,- "is_monthly": false,- "is_nsfw": false,- "is_plural": false,- "main_video_embed": null,- "main_video_url": null,- "one_liner": null,- "outstanding_payment_amount_cents": 0,- "patron_count": 0,- "pay_per_name": null,- "pledge_sum": 0,- "pledge_url": "/bePatron?c=0000000",- "published_at": "2017-10-20T21:49:31+00:00",- "summary": null,- "thanks_embed": null,- "thanks_msg": null,- "thanks_video_url": null+ "name": "Documentation",+ "patron_count": 3},"id": "0000000","relationships": {@@ -33,228 +11,62 @@"data": {"id": "1111111","type": "user"- },- "links": {- "related": "https://www.patreon.com/api/user/1111111"}},- "goals": {- "data": []- },- "rewards": {- "data": [{- "id": "-1",- "type": "reward"- },- {- "id": "0",- "type": "reward"- },+ "tiers": {+ "data": [{"id": "999997",- "type": "reward"+ "type": "tier"},{"id": "999998",- "type": "reward"+ "type": "tier"},{"id": "999999",- "type": "reward"+ "type": "tier"}]- },- "pledges": {- "links": {- "first": "https://www.patreon.com/api/oauth2/api/campaigns/70261/pledges?page%5Bcount%5D=20&sort=created",- "next": "https://www.patreon.com/api/oauth2/api/campaigns/70261/pledges?page%5Bcount%5D=20&sort=created&page%5Bcursor%5D=2017-08-21T20%3A16%3A49.258893%2B00%3A00"- }}},"type": "campaign"}],- "included": [{+ "included": [+ {"attributes": {- "about": null,- "created": "2017-10-20T21:36:23+00:00",- "discord_id": null,"email": "[email protected]",- "facebook": null,- "facebook_id": null,- "first_name": "Corgi",- "full_name": "Corgi The Dev",- "gender": 0,- "has_password": true,- "image_url": "https://c8.patreon.com/2/400/1111111",- "is_deleted": false,- "is_email_verified": false,- "is_nuked": false,- "is_suspended": false,- "last_name": "The Dev",- "social_connections": {- "deviantart": null,- "discord": null,- "facebook": null,- "spotify": null,- "twitch": null,- "twitter": null,- "youtube": null- },- "thumb_url": "https://c8.patreon.com/2/100/1111111",- "twitch": null,- "twitter": null,- "url": "https://www.patreon.com/drkthedev",- "vanity": "drkthedev",- "youtube": null+ "full_name": "Corgi The Dev"},"id": "1111111",- "relationships": {- "campaign": {- "data": {- "id": "0000000",- "type": "campaign"- },- "links": {- "related": "https://www.patreon.com/api/campaigns/0000000"- }- }- },"type": "user"},{"attributes": {- "amount": 0,- "amount_cents": 0,- "created_at": null,- "description": "Everyone",- "id": "-1",- "remaining": 0,- "requires_shipping": false,- "type": "reward",- "url": null,- "user_limit": null- },- "id": "-1",- "relationships": {- "creator": {- "data": {- "id": "1111111",- "type": "user"- },- "links": {- "related": "https://www.patreon.com/api/user/1111111"- }- }- },- "type": "reward"- },- {- "attributes": {- "amount": 1,- "amount_cents": 1,- "created_at": null,- "description": "Patrons Only",- "id": "0",- "remaining": 0,- "requires_shipping": false,- "type": "reward",- "url": null,- "user_limit": null- },- "id": "0",- "relationships": {- "creator": {- "data": {- "id": "1111111",- "type": "user"- },- "links": {- "related": "https://www.patreon.com/api/user/1111111"- }- }- },- "type": "reward"- },- {- "attributes": {- "amount": 10,+ "title": "Standard","amount_cents": 10,- "created_at": null,- "description": "Standard",- "id": "0",- "remaining": 0,- "requires_shipping": false,- "type": "reward",- "url": null,- "user_limit": null+ "created_at": null},"id": "999997",- "relationships": {- "creator": {- "data": {- "id": "1111111",- "type": "user"- },- "links": {- "related": "https://www.patreon.com/api/user/1111111"- }- }- },- "type": "reward"+ "type": "tier"},{"attributes": {- "amount": 100,+ "title": "Pro","amount_cents": 100,- "created_at": null,- "description": "Pro",- "id": "0",- "remaining": 0,- "requires_shipping": false,- "type": "reward",- "url": null,- "user_limit": null+ "created_at": null},"id": "999998",- "relationships": {- "creator": {- "data": {- "id": "1111111",- "type": "user"- },- "links": {- "related": "https://www.patreon.com/api/user/1111111"- }- }- },- "type": "reward"+ "type": "tier"},{"attributes": {- "amount": 1000,+ "title": "Premium","amount_cents": 1000,- "created_at": null,- "description": "Premium",- "id": "0",- "remaining": 0,- "requires_shipping": false,- "type": "reward",- "url": null,- "user_limit": null+ "created_at": null},"id": "999999",- "relationships": {- "creator": {- "data": {- "id": "1111111",- "type": "user"- },- "links": {- "related": "https://www.patreon.com/api/user/1111111"- }- }- },- "type": "reward"+ "type": "tier"}]}diff --git a/plugins/discourse-patreon/spec/fixtures/member.json b/plugins/discourse-patreon/spec/fixtures/member.jsonindex 9e02639f084..85d09b378b5 100644--- a/plugins/discourse-patreon/spec/fixtures/member.json+++ b/plugins/discourse-patreon/spec/fixtures/member.json@@ -1,33 +1,20 @@{"data": {"attributes": {- "currently_entitled_amount_cents": null,- "full_name": "Platform",- "is_follower": true,- "last_charge_date": null,- "last_charge_status": null,- "lifetime_support_cents": 0,- "note": "",- "patron_status": null,- "pledge_relationship_start": null+ "currently_entitled_amount_cents": 250,+ "last_charge_date": "2015-05-18T23:50:42+00:00",+ "last_charge_status": "Paid",+ "patron_status": "active_patron",+ "email": "[email protected]"},"id": "d485d5ac-6c82-42c6-9c08-c50cf01b73d7","relationships": {- "address": {- "data": null- },- "campaign": {- "data": {- "id": "123456",- "type": "campaign"- }- },"currently_entitled_tiers": {- "data": []+ "data": [{ "id": "999999", "type": "tier" }]},"user": {"data": {- "id": "987654321",+ "id": "32187","type": "user"}}@@ -37,61 +24,11 @@"included": [{"attributes": {- "about": "sample text about",- "created": "2015-01-15T07:25:51+00:00","email": "[email protected]",- "facebook": null,- "first_name": "Roo",- "full_name": "Roo Aar",- "gender": 1,- "image_url": "",- "is_email_verified": true,- "last_name": "Aar",- "social_connections": {- "deviantart": null,- "discord": null,- "facebook": null,- "spotify": null,- "twitch": null,- "twitter": null,- "youtube": null- },- "thumb_url": "",- "twitch": null,- "twitter": "roo",- "url": "https://www.patreon.com/foo",- "vanity": "roo",- "youtube": null+ "full_name": "Roo Aar"},- "id": "987654321",+ "id": "32187","type": "user"- },- {- "attributes": {- "amount": 1,- "amount_cents": 1,- "created_at": null,- "description": "Patrons Only",- "id": "999999",- "remaining": 0,- "requires_shipping": false,- "type": "reward",- "url": null,- "user_limit": null- },- "id": "999999",- "relationships": {- "creator": {- "data": {- "id": "1111111",- "type": "user"- },- "links": {- "related": "https://www.patreon.com/api/user/1111111"- }- }- },- "type": "reward"}]}diff --git a/plugins/discourse-patreon/spec/fixtures/members.json b/plugins/discourse-patreon/spec/fixtures/members.jsonnew file mode 100644index 00000000000..07ec3f3140a--- /dev/null+++ b/plugins/discourse-patreon/spec/fixtures/members.json@@ -0,0 +1,92 @@+{+ "data": [+ {+ "attributes": {+ "currently_entitled_amount_cents": 0,+ "last_charge_date": null,+ "last_charge_status": "Paid",+ "patron_status": "active_patron",+ "email": "[email protected]"+ },+ "id": "member-1",+ "relationships": {+ "currently_entitled_tiers": {+ "data": [{ "id": "999999", "type": "tier" }]+ },+ "user": {+ "data": { "id": "111111", "type": "user" }+ }+ },+ "type": "member"+ },+ {+ "attributes": {+ "currently_entitled_amount_cents": 100,+ "last_charge_date": "2017-11-07T20:59:52+00:00",+ "last_charge_status": "Declined",+ "patron_status": "declined_patron",+ "email": "[email protected]"+ },+ "id": "member-2",+ "relationships": {+ "currently_entitled_tiers": {+ "data": [{ "id": "999998", "type": "tier" }]+ },+ "user": {+ "data": { "id": "111112", "type": "user" }+ }+ },+ "type": "member"+ },+ {+ "attributes": {+ "currently_entitled_amount_cents": 200,+ "last_charge_date": "2017-11-10T20:59:52+00:00",+ "last_charge_status": "Declined",+ "patron_status": "declined_patron",+ "email": "[email protected]"+ },+ "id": "member-3",+ "relationships": {+ "currently_entitled_tiers": {+ "data": [{ "id": "999997", "type": "tier" }]+ },+ "user": {+ "data": { "id": "111113", "type": "user" }+ }+ },+ "type": "member"+ }+ ],+ "included": [+ {+ "attributes": {+ "email": "[email protected]",+ "full_name": "Foo Bar"+ },+ "id": "111111",+ "type": "user"+ },+ {+ "attributes": {+ "email": "[email protected]",+ "full_name": "Boo Far"+ },+ "id": "111112",+ "type": "user"+ },+ {+ "attributes": {+ "email": "[email protected]",+ "full_name": "Roo Aar"+ },+ "id": "111113",+ "type": "user"+ }+ ],+ "meta": {+ "pagination": {+ "total": 3+ }+ }+}diff --git a/plugins/discourse-patreon/spec/fixtures/v1/campaigns.json b/plugins/discourse-patreon/spec/fixtures/v1/campaigns.jsonnew file mode 100644index 00000000000..c2b6b99f03d--- /dev/null+++ b/plugins/discourse-patreon/spec/fixtures/v1/campaigns.json@@ -0,0 +1,260 @@+{+ "data": [{+ "attributes": {+ "created_at": "2017-10-20T21:39:01+00:00",+ "creation_count": 0,+ "creation_name": "Documentation",+ "discord_server_id": null,+ "display_patron_goals": false,+ "earnings_visibility": "public",+ "image_small_url": null,+ "image_url": null,+ "is_charged_immediately": false,+ "is_monthly": false,+ "is_nsfw": false,+ "is_plural": false,+ "main_video_embed": null,+ "main_video_url": null,+ "one_liner": null,+ "outstanding_payment_amount_cents": 0,+ "patron_count": 0,+ "pay_per_name": null,+ "pledge_sum": 0,+ "pledge_url": "/bePatron?c=0000000",+ "published_at": "2017-10-20T21:49:31+00:00",+ "summary": null,+ "thanks_embed": null,+ "thanks_msg": null,+ "thanks_video_url": null+ },+ "id": "0000000",+ "relationships": {+ "creator": {+ "data": {+ "id": "1111111",+ "type": "user"+ },+ "links": {+ "related": "https://www.patreon.com/api/user/1111111"+ }+ },+ "goals": {+ "data": []+ },+ "rewards": {+ "data": [{+ "id": "-1",+ "type": "reward"+ },+ {+ "id": "0",+ "type": "reward"+ },+ {+ "id": "999997",+ "type": "reward"+ },+ {+ "id": "999998",+ "type": "reward"+ },+ {+ "id": "999999",+ "type": "reward"+ }+ ]+ },+ "pledges": {+ "links": {+ "first": "https://www.patreon.com/api/oauth2/api/campaigns/70261/pledges?page%5Bcount%5D=20&sort=created",+ "next": "https://www.patreon.com/api/oauth2/api/campaigns/70261/pledges?page%5Bcount%5D=20&sort=created&page%5Bcursor%5D=2017-08-21T20%3A16%3A49.258893%2B00%3A00"+ }+ }+ },+ "type": "campaign"+ }],+ "included": [{+ "attributes": {+ "about": null,+ "created": "2017-10-20T21:36:23+00:00",+ "discord_id": null,+ "email": "[email protected]",+ "facebook": null,+ "facebook_id": null,+ "first_name": "Corgi",+ "full_name": "Corgi The Dev",+ "gender": 0,+ "has_password": true,+ "image_url": "https://c8.patreon.com/2/400/1111111",+ "is_deleted": false,+ "is_email_verified": false,+ "is_nuked": false,+ "is_suspended": false,+ "last_name": "The Dev",+ "social_connections": {+ "deviantart": null,+ "discord": null,+ "facebook": null,+ "spotify": null,+ "twitch": null,+ "twitter": null,+ "youtube": null+ },+ "thumb_url": "https://c8.patreon.com/2/100/1111111",+ "twitch": null,+ "twitter": null,+ "url": "https://www.patreon.com/drkthedev",+ "vanity": "drkthedev",+ "youtube": null+ },+ "id": "1111111",+ "relationships": {+ "campaign": {+ "data": {+ "id": "0000000",+ "type": "campaign"+ },+ "links": {+ "related": "https://www.patreon.com/api/campaigns/0000000"+ }+ }+ },+ "type": "user"+ },+ {+ "attributes": {+ "amount": 0,+ "amount_cents": 0,+ "created_at": null,+ "description": "Everyone",+ "id": "-1",+ "remaining": 0,+ "requires_shipping": false,+ "type": "reward",+ "url": null,+ "user_limit": null+ },+ "id": "-1",+ "relationships": {+ "creator": {+ "data": {+ "id": "1111111",+ "type": "user"+ },+ "links": {+ "related": "https://www.patreon.com/api/user/1111111"+ }+ }+ },+ "type": "reward"+ },+ {+ "attributes": {+ "amount": 1,+ "amount_cents": 1,+ "created_at": null,+ "description": "Patrons Only",+ "id": "0",+ "remaining": 0,+ "requires_shipping": false,+ "type": "reward",+ "url": null,+ "user_limit": null+ },+ "id": "0",+ "relationships": {+ "creator": {+ "data": {+ "id": "1111111",+ "type": "user"+ },+ "links": {+ "related": "https://www.patreon.com/api/user/1111111"+ }+ }+ },+ "type": "reward"+ },+ {+ "attributes": {+ "amount": 10,+ "amount_cents": 10,+ "created_at": null,+ "description": "Standard",+ "id": "0",+ "remaining": 0,+ "requires_shipping": false,+ "type": "reward",+ "url": null,+ "user_limit": null+ },+ "id": "999997",+ "relationships": {+ "creator": {+ "data": {+ "id": "1111111",+ "type": "user"+ },+ "links": {+ "related": "https://www.patreon.com/api/user/1111111"+ }+ }+ },+ "type": "reward"+ },+ {+ "attributes": {+ "amount": 100,+ "amount_cents": 100,+ "created_at": null,+ "description": "Pro",+ "id": "0",+ "remaining": 0,+ "requires_shipping": false,+ "type": "reward",+ "url": null,+ "user_limit": null+ },+ "id": "999998",+ "relationships": {+ "creator": {+ "data": {+ "id": "1111111",+ "type": "user"+ },+ "links": {+ "related": "https://www.patreon.com/api/user/1111111"+ }+ }+ },+ "type": "reward"+ },+ {+ "attributes": {+ "amount": 1000,+ "amount_cents": 1000,+ "created_at": null,+ "description": "Premium",+ "id": "0",+ "remaining": 0,+ "requires_shipping": false,+ "type": "reward",+ "url": null,+ "user_limit": null+ },+ "id": "999999",+ "relationships": {+ "creator": {+ "data": {+ "id": "1111111",+ "type": "user"+ },+ "links": {+ "related": "https://www.patreon.com/api/user/1111111"+ }+ }+ },+ "type": "reward"+ }+ ]+}diff --git a/plugins/discourse-patreon/spec/fixtures/pledge.json b/plugins/discourse-patreon/spec/fixtures/v1/pledge.jsonsimilarity index 100%rename from plugins/discourse-patreon/spec/fixtures/pledge.jsonrename to plugins/discourse-patreon/spec/fixtures/v1/pledge.jsondiff --git a/plugins/discourse-patreon/spec/fixtures/pledges.json b/plugins/discourse-patreon/spec/fixtures/v1/pledges.jsonsimilarity index 100%rename from plugins/discourse-patreon/spec/fixtures/pledges.jsonrename to plugins/discourse-patreon/spec/fixtures/v1/pledges.jsondiff --git a/plugins/discourse-patreon/spec/integration/patreon_auth_spec.rb b/plugins/discourse-patreon/spec/integration/patreon_auth_spec.rbindex c1b2e781c39..8be5ddaede7 100644--- a/plugins/discourse-patreon/spec/integration/patreon_auth_spec.rb+++ b/plugins/discourse-patreon/spec/integration/patreon_auth_spec.rb@@ -9,77 +9,135 @@ describe "Patreon Oauth2" dofab!(:user1, :user)fab!(:user2, :user)- def setup_patreon_emails_stub(email:, verified:)- stub_request(:get, "https://api.patreon.com/oauth2/api/current_user").with(- headers: {- "Authorization" => "Bearer #{access_token}",- },- ).to_return(- status: 200,- body:- JSON.dump(- data: {- id: "493290423324",- attributes: {- email: email,- full_name: "Patron",- is_email_verified: verified,- },- },- ),- headers: {- "Content-Type" => "application/json",- },- )- end-before doSiteSetting.patreon_creator_discourse_username = user2.usernameSiteSetting.patreon_login_enabled = trueSiteSetting.patreon_client_id = client_idSiteSetting.patreon_client_secret = client_secret+ end++ shared_examples "patreon oauth" do+ it "doesn't sign in the user if the email from patreon is not verified" do+ post "/auth/patreon"+ expect(response.status).to eq(302)+ expect(response.location).to start_with("https://www.patreon.com/oauth2/authorize")++ setup_patreon_stubs(email: user1.email, verified: false)++ post "/auth/patreon/callback", params: { state: session["omniauth.state"], code: temp_code }+ expect(response.status).to eq(302)+ expect(response.location).to eq("http://test.localhost/")+ expect(session[:current_user_id]).to be_blank+ end- stub_request(:post, "https://api.patreon.com/oauth2/token").with(- body:- hash_including(- "client_id" => client_id,- "client_secret" => client_secret,- "code" => temp_code,- "grant_type" => "authorization_code",- "redirect_uri" => "http://test.localhost/auth/patreon/callback",- ),- ).to_return(- status: 200,- body: Rack::Utils.build_query(access_token: access_token),- headers: {- "Content-Type" => "application/x-www-form-urlencoded",- },- )+ it "signs in the user if the email from patreon is verified" do+ post "/auth/patreon"+ expect(response.status).to eq(302)+ expect(response.location).to start_with("https://www.patreon.com/oauth2/authorize")++ setup_patreon_stubs(email: user1.email, verified: true)++ post "/auth/patreon/callback", params: { state: session["omniauth.state"], code: temp_code }+ expect(response.status).to eq(302)+ expect(response.location).to eq("http://test.localhost/")+ expect(session[:current_user_id]).to eq(user1.id)+ endend- it "doesn't sign in the user if the email from patreon is not verified" do- post "/auth/patreon"- expect(response.status).to eq(302)- expect(response.location).to start_with("https://www.patreon.com/oauth2/authorize")+ context "with API v1" do+ before do+ SiteSetting.patreon_api_version = "1"++ stub_request(:post, "https://api.patreon.com/oauth2/token").with(+ body:+ hash_including(+ "client_id" => client_id,+ "client_secret" => client_secret,+ "code" => temp_code,+ "grant_type" => "authorization_code",+ "redirect_uri" => "http://test.localhost/auth/patreon/callback",+ ),+ ).to_return(+ status: 200,+ body: Rack::Utils.build_query(access_token: access_token),+ headers: {+ "Content-Type" => "application/x-www-form-urlencoded",+ },+ )+ end- setup_patreon_emails_stub(email: user1.email, verified: false)+ def setup_patreon_stubs(email:, verified:)+ stub_request(:get, "https://api.patreon.com/oauth2/api/current_user").with(+ headers: {+ "Authorization" => "Bearer #{access_token}",+ },+ ).to_return(+ status: 200,+ body:+ JSON.dump(+ data: {+ id: "493290423324",+ attributes: {+ email: email,+ full_name: "Patron",+ is_email_verified: verified,+ },+ },+ ),+ headers: {+ "Content-Type" => "application/json",+ },+ )+ end- post "/auth/patreon/callback", params: { state: session["omniauth.state"], code: temp_code }- expect(response.status).to eq(302)- expect(response.location).to eq("http://test.localhost/")- expect(session[:current_user_id]).to be_blank+ include_examples "patreon oauth"end- it "signs in the user if the email from patreon is verified" do- post "/auth/patreon"- expect(response.status).to eq(302)- expect(response.location).to start_with("https://www.patreon.com/oauth2/authorize")+ context "with API v2" do+ before do+ SiteSetting.patreon_api_version = "2"++ stub_request(:post, "https://www.patreon.com/api/oauth2/token").with(+ body:+ hash_including(+ "client_id" => client_id,+ "client_secret" => client_secret,+ "code" => temp_code,+ "grant_type" => "authorization_code",+ "redirect_uri" => "http://test.localhost/auth/patreon/callback",+ ),+ ).to_return(+ status: 200,+ body: Rack::Utils.build_query(access_token: access_token),+ headers: {+ "Content-Type" => "application/x-www-form-urlencoded",+ },+ )+ end- setup_patreon_emails_stub(email: user1.email, verified: true)+ def setup_patreon_stubs(email:, verified:)+ stub_request(+ :get,+ "https://www.patreon.com/api/oauth2/v2/identity?fields%5Buser%5D=email,full_name,is_email_verified",+ ).with(headers: { "Authorization" => "Bearer #{access_token}" }).to_return(+ status: 200,+ body:+ JSON.dump(+ data: {+ id: "493290423324",+ attributes: {+ email: email,+ full_name: "Patron",+ is_email_verified: verified,+ },+ },+ ),+ headers: {+ "Content-Type" => "application/json",+ },+ )+ end- post "/auth/patreon/callback", params: { state: session["omniauth.state"], code: temp_code }- expect(response.status).to eq(302)- expect(response.location).to eq("http://test.localhost/")- expect(session[:current_user_id]).to eq(user1.id)+ include_examples "patreon oauth"endenddiff --git a/plugins/discourse-patreon/spec/jobs/patreon_update_tokens_spec.rb b/plugins/discourse-patreon/spec/jobs/patreon_update_tokens_spec.rbindex e43d96dd79c..29ccafce90a 100644--- a/plugins/discourse-patreon/spec/jobs/patreon_update_tokens_spec.rb+++ b/plugins/discourse-patreon/spec/jobs/patreon_update_tokens_spec.rb@@ -3,23 +3,48 @@require_relative "../spec_helper"RSpec.describe Jobs::PatreonUpdateTokens do- before do- SiteSetting.patreon_enabled = true-- 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"))+ 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")+ endend- it "should update both access and refresh tokens from Patreon" do- described_class.new.execute({})+ 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- expect(SiteSetting.patreon_creator_access_token).to eq("ACCESS TOKEN")- expect(SiteSetting.patreon_creator_refresh_token).to eq("REFRESH TOKEN")+ include_examples "token refresh"endenddiff --git a/plugins/discourse-patreon/spec/lib/api_spec.rb b/plugins/discourse-patreon/spec/lib/api_spec.rbindex 2f84ec68413..cd97910d8b6 100644--- a/plugins/discourse-patreon/spec/lib/api_spec.rb+++ b/plugins/discourse-patreon/spec/lib/api_spec.rb@@ -1,39 +1,58 @@# frozen_string_literal: trueRSpec.describe Patreon::Api do- let(:url) do- "https://api.patreon.com/oauth2/api/current_user/campaigns?include=rewards,creator,goals,pledges&page%5Bcount%5D=100"- end-- def stub(status)+ def stub_url(status, url)content = { status: status, headers: { "Content-Type" => "application/json" }, body: "{}" }-stub_request(:get, url).to_return(content)endbefore { SiteSetting.stubs(patreon_enabled: true) }- it "should add admin warning message for invalid api response" do- stub(401)+ context "with API v1" do+ let(:url) do+ "https://api.patreon.com/oauth2/api/current_user/campaigns?include=rewards,creator,goals,pledges&page%5Bcount%5D=100"+ end- described_class.get(url)+ before { SiteSetting.patreon_api_version = "1" }- expect(ProblemCheckTracker[:access_token_invalid].blips).to eq(1)- expect(AdminNotice.find_by(identifier: :access_token_invalid).message).to eq(- I18n.t("dashboard.problem.access_token_invalid", base_path: Discourse.base_path),- )- end-- it "should not add admin warning message for valid api response" do- stub(200)+ it "should add admin warning message for invalid api response" do+ stub_url(401, url)+ described_class.campaign_data+ expect(ProblemCheckTracker[:access_token_invalid].blips).to eq(1)+ end- expect(ProblemCheckTracker[:access_token_invalid].blips).to eq(0)+ it "should add warning log" do+ stub_url(500, url)+ Discourse.expects(:warn_exception).once+ described_class.campaign_data+ endend- it "should add warning log" do- stub(500)-- Discourse.expects(:warn_exception).once- expect(described_class.get(url)).to eq(error: I18n.t(described_class::INVALID_RESPONSE))+ context "with API v2" do+ let(:url) do+ "https://www.patreon.com/api/oauth2/v2/campaigns?include=tiers,creator&fields%5Bcampaign%5D=created_at,name,patron_count&fields%5Btier%5D=title,amount_cents,created_at"+ end++ before { SiteSetting.patreon_api_version = "2" }++ it "should add admin warning message for invalid api response" do+ stub_url(401, url)+ described_class.campaign_data+ expect(ProblemCheckTracker[:access_token_invalid].blips).to eq(1)+ expect(AdminNotice.find_by(identifier: :access_token_invalid).message).to eq(+ I18n.t("dashboard.problem.access_token_invalid", base_path: Discourse.base_path),+ )+ end++ it "should not add admin warning message for valid api response" do+ stub_url(200, url)+ expect(ProblemCheckTracker[:access_token_invalid].blips).to eq(0)+ end++ it "should add warning log" do+ stub_url(500, url)+ Discourse.expects(:warn_exception).once+ expect(described_class.campaign_data).to eq(error: I18n.t(described_class::INVALID_RESPONSE))+ endendenddiff --git a/plugins/discourse-patreon/spec/lib/campaign_spec.rb b/plugins/discourse-patreon/spec/lib/campaign_spec.rbindex 2d3e9b8c25e..767ec9b6bb3 100644--- a/plugins/discourse-patreon/spec/lib/campaign_spec.rb+++ b/plugins/discourse-patreon/spec/lib/campaign_spec.rb@@ -3,42 +3,75 @@require_relative "../spec_helper"RSpec.describe Patreon::Campaign do- before do- campaigns_url =- "https://api.patreon.com/oauth2/api/current_user/campaigns?include=rewards,creator,goals,pledges&page%5Bcount%5D=100"- pledges_url =- "https://www.patreon.com/api/oauth2/api/campaigns/70261/pledges?page%5Bcount%5D=100&sort=created"- content = { status: 200, headers: { "Content-Type" => "application/json" } }-- campaigns = content.merge(body: get_patreon_response("campaigns.json"))- pledges = content.merge(body: get_patreon_response("pledges.json"))-- stub_request(:get, campaigns_url).to_return(campaigns)- stub_request(:get, pledges_url).to_return(pledges)- SiteSetting.patreon_enabled = true- SiteSetting.patreon_declined_pledges_grace_period_days = 7+ shared_examples "campaign sync" do+ it "should update campaigns and group users data" do+ expect { described_class.update! }.to change { Group.count }.by(1)++ expect(Group.find_by(name: "patrons")).to be_present+ expect(Badge.find_by(name: "Patron")).to be_present+ expect(Patreon.get("pledges").count).to eq(3)+ expect(Patreon::Pledge::Decline.all.count).to eq(2)+ expect(Patreon.get("rewards").count).to eq(expected_rewards_count)+ expect(Patreon.get("users").count).to eq(3)+ expect(Patreon.get("reward-users")["0"].count).to eq(3)+ expect(Patreon.get("filters").count).to eq(1)++ expect {+ Patreon+ .get("users")+ .each do |id, email|+ cf = Fabricate(:user, email: email).custom_fields+ expect(cf["patreon_id"]).to eq(id)+ end+ }.to change { GroupUser.count }.by(3)+ end+ end++ context "with API v1" do+ let(:expected_rewards_count) { 5 }++ before do+ campaigns_url =+ "https://api.patreon.com/oauth2/api/current_user/campaigns?include=rewards,creator,goals,pledges&page%5Bcount%5D=100"+ pledges_url =+ "https://www.patreon.com/api/oauth2/api/campaigns/70261/pledges?page%5Bcount%5D=100&sort=created"+ content = { status: 200, headers: { "Content-Type" => "application/json" } }++ stub_request(:get, campaigns_url).to_return(+ content.merge(body: get_patreon_response("v1/campaigns.json")),+ )+ stub_request(:get, pledges_url).to_return(+ content.merge(body: get_patreon_response("v1/pledges.json")),+ )+ SiteSetting.patreon_enabled = true+ SiteSetting.patreon_api_version = "1"+ SiteSetting.patreon_declined_pledges_grace_period_days = 7+ end++ include_examples "campaign sync"end- it "should update campaigns and group users data" do- expect { described_class.update! }.to change { Group.count }.by(1).and change {- Badge.count- }.by(1)-- expect(Patreon.get("pledges").count).to eq(3)- expect(Patreon::Pledge::Decline.all.count).to eq(2)- expect(Patreon.get("rewards").count).to eq(5)- expect(Patreon.get("users").count).to eq(3)- expect(Patreon.get("reward-users")["0"].count).to eq(3)- expect(Patreon.get("filters").count).to eq(1)-- # To check `add_model_callback(User, :after_commit, on: :create)` in plugin.rb- expect {- Patreon- .get("users")- .each do |id, email|- cf = Fabricate(:user, email: email).custom_fields- expect(cf["patreon_id"]).to eq(id)- end- }.to change { GroupUser.count }.by(3)+ context "with API v2" do+ let(:expected_rewards_count) { 4 }++ before do+ campaigns_url =+ "https://www.patreon.com/api/oauth2/v2/campaigns?include=tiers,creator&fields%5Bcampaign%5D=created_at,name,patron_count&fields%5Btier%5D=title,amount_cents,created_at"+ members_url =+ "https://www.patreon.com/api/oauth2/v2/campaigns/0000000/members?include=currently_entitled_tiers,user&fields%5Bmember%5D=full_name,last_charge_date,last_charge_status,currently_entitled_amount_cents,patron_status,email&fields%5Buser%5D=email,full_name&fields%5Btier%5D=title,amount_cents,created_at&page%5Bcount%5D=1000"+ content = { status: 200, headers: { "Content-Type" => "application/json" } }++ stub_request(:get, campaigns_url).to_return(+ content.merge(body: get_patreon_response("campaigns.json")),+ )+ stub_request(:get, members_url).to_return(+ content.merge(body: get_patreon_response("members.json")),+ )+ SiteSetting.patreon_enabled = true+ SiteSetting.patreon_api_version = "2"+ SiteSetting.patreon_declined_pledges_grace_period_days = 7+ end++ include_examples "campaign sync"endenddiff --git a/plugins/discourse-patreon/spec/lib/seed_spec.rb b/plugins/discourse-patreon/spec/lib/seed_spec.rbindex 419d3165855..44aa3d09b98 100644--- a/plugins/discourse-patreon/spec/lib/seed_spec.rb+++ b/plugins/discourse-patreon/spec/lib/seed_spec.rb@@ -3,10 +3,10 @@RSpec.describe Patreon::Seed doit "should seed contents correctly" dodescribed_class.seed_content!- group = Group.last- expect(group.name).to eq("patrons")+ group = Group.find_by(name: "patrons")+ expect(group).to be_presentexpect(group.flair_upload).to be_present- expect(Badge.last.name).to eq("Patron")+ expect(Badge.find_by(name: "Patron")).to be_presentexpect(Patreon.get("filters")).to eq(group.id.to_s => ["0"])end@@ -17,7 +17,11 @@ RSpec.describe Patreon::Seed doendit "should not raise error if badge already exists" do- Fabricate(:badge, name: "Patron")- described_class.seed_content!+ Badge.where(name: "Patron").first_or_create!(+ badge_type_id: 1,+ description: "test",+ listable: true,+ )+ expect { described_class.seed_content! }.not_to raise_errorendenddiff --git a/plugins/discourse-patreon/spec/requests/patreon_webhook_controller_spec.rb b/plugins/discourse-patreon/spec/requests/patreon_webhook_controller_spec.rbindex 681cbacfa9b..5786b59e28c 100644--- a/plugins/discourse-patreon/spec/requests/patreon_webhook_controller_spec.rb+++ b/plugins/discourse-patreon/spec/requests/patreon_webhook_controller_spec.rb@@ -37,7 +37,7 @@ RSpec.describe Patreon::PatreonWebhookController doexpect_not_enqueued_with(job: :patreon_sync_patrons_to_groups) dopost "/patreon/webhook",headers: {- "X-Patreon-Event": "pledges:create",+ "X-Patreon-Event": "members:pledge:create","X-Patreon-Signature": "foo",}end@@ -48,7 +48,7 @@ RSpec.describe Patreon::PatreonWebhookController doit "returns a 403 error when webhook secret is blank" doSiteSetting.patreon_webhook_secret = ""- body = get_patreon_response("pledge.json")+ body = get_patreon_response("member.json")digest = OpenSSL::Digest.new("MD5")forged_signature = OpenSSL::HMAC.hexdigest(digest, "", body)@@ -56,7 +56,7 @@ RSpec.describe Patreon::PatreonWebhookController dopost "/patreon/webhook",params: body,headers: {- "X-Patreon-Event": "pledges:create",+ "X-Patreon-Event": "members:pledge:create","X-Patreon-Signature": forged_signature,}end@@ -66,8 +66,8 @@ RSpec.describe Patreon::PatreonWebhookController doendend- describe "enqueue job" do- let(:body) { get_patreon_response("pledge.json") }+ describe "v2 member webhooks" do+ let(:body) { get_patreon_response("member.json") }let(:digest) { OpenSSL::Digest.new("MD5") }let(:secret) { SiteSetting.patreon_webhook_secret = "WEBHOOK SECRET" }@@ -85,23 +85,22 @@ RSpec.describe Patreon::PatreonWebhookController do)end- def add_pledge- pledge_data = JSON.parse(body)- Patreon::Pledge.create!(pledge_data.dup)-- pledge_data+ def add_member+ member_data = JSON.parse(body)+ Patreon::Pledge.create!(member_data.dup, adapter: Patreon::ApiVersion::V2)+ member_dataend- def post_request(body, event, type = "pledges")+ def post_request(body, event)post "/patreon/webhook",params: body,headers: {- "X-Patreon-Event": "#{type}:#{event}",+ "X-Patreon-Event": "members:pledge:#{event}","X-Patreon-Signature": OpenSSL::HMAC.hexdigest(digest, secret, body),}end- it "for event pledge:create" do+ it "for event members:pledge:create" douser = Fabricate(:user, email: "[email protected]")group = Fabricate(:group)Patreon.set("filters", group.id.to_s => ["0"])@@ -115,22 +114,80 @@ RSpec.describe Patreon::PatreonWebhookController doexpect(group.users).to include(user)end- it "for event members:pledge:create" do- body = get_patreon_response("member.json")+ it "for event members:pledge:update" do+ member_data = add_member+ member = member_data["data"]+ member["attributes"]["currently_entitled_amount_cents"] = 987+ patron_id = member["relationships"]["user"]["data"]["id"]+ member_data = JSON.pretty_generate(member_data)++ expect(Patreon.get("pledges")[patron_id]).to eq(250)+ post_request(member_data, "update")+ expect(Patreon.get("pledges")[patron_id]).to eq(987)+ end++ it "for event members:pledge:delete" do+ add_member+ tier_id =+ JSON.parse(body)["data"]["relationships"]["currently_entitled_tiers"]["data"][0]["id"]++ expect { post_request(body, "delete") }.to change { Patreon::Pledge.all.keys.count }.by(+ -1,+ ).and change { Patreon::Patron.all.keys.count }.by(-1).and change {+ Patreon::RewardUser.all[tier_id].count+ }.by(-1)+ end+ end++ describe "v1 pledge webhooks" do+ let(:body) { get_patreon_response("v1/pledge.json") }+ let(:digest) { OpenSSL::Digest.new("MD5") }+ let(:secret) { SiteSetting.patreon_webhook_secret = "WEBHOOK SECRET" }++ before do+ Patreon.set(+ "rewards",+ "0": {+ title: "All Patrons",+ amount_cents: 0,+ },+ "999999": {+ title: "Premium",+ amount_cents: 1000,+ },+ )+ end++ def add_pledge+ pledge_data = JSON.parse(body)+ Patreon::Pledge.create!(pledge_data.dup, adapter: Patreon::ApiVersion::V1)+ pledge_data+ end++ def post_request(body, event)+ post "/patreon/webhook",+ params: body,+ headers: {+ "X-Patreon-Event": "pledges:#{event}",+ "X-Patreon-Signature": OpenSSL::HMAC.hexdigest(digest, secret, body),+ }+ end++ it "for event pledges:create" douser = Fabricate(:user, email: "[email protected]")group = Fabricate(:group)Patreon.set("filters", group.id.to_s => ["0"])- expect { post_request(body, "create", "members:pledge") }.to change {- Patreon::Pledge.all.keys.count- }.by(1).and change { Patreon::Patron.all.keys.count }.by(1).and change {+ expect { post_request(body, "create") }.to change { Patreon::Pledge.all.keys.count }.by(+ 1,+ ).and change { Patreon::Patron.all.keys.count }.by(1).and change {Patreon::RewardUser.all.keys.count}.by(2)expect(group.users).to include(user)end- it "for event pledge:update" do+ it "for event pledges:update" dopledge_data = add_pledgepledge = pledge_data["data"]pledge["attributes"]["amount_cents"] = 987@@ -142,9 +199,8 @@ RSpec.describe Patreon::PatreonWebhookController doexpect(Patreon.get("pledges")[patron_id]).to eq(987)end- it "for event pledge:delete" do+ it "for event pledges:delete" dopledge_data = add_pledge- patron_id = pledge_data["data"]["relationships"]["patron"]["data"]["id"]reward_id = pledge_data["data"]["relationships"]["reward"]["data"]["id"]expect { post_request(body, "delete") }.to change { Patreon::Pledge.all.keys.count }.by(diff --git a/plugins/discourse-patreon/spec/services/problem_check/patreon_api_v1_deprecated_spec.rb b/plugins/discourse-patreon/spec/services/problem_check/patreon_api_v1_deprecated_spec.rbnew file mode 100644index 00000000000..e675de70c21--- /dev/null+++ b/plugins/discourse-patreon/spec/services/problem_check/patreon_api_v1_deprecated_spec.rb@@ -0,0 +1,21 @@+# frozen_string_literal: true++RSpec.describe ProblemCheck::PatreonApiV1Deprecated do+ before { SiteSetting.patreon_enabled = true }++ it "warns when using API v1" do+ SiteSetting.patreon_api_version = "1"+ expect(described_class.new.call).to be_present+ end++ it "does not warn when using API v2" do+ SiteSetting.patreon_api_version = "2"+ expect(described_class.new.call).to be_blank+ end++ it "does not warn when the plugin is disabled" do+ SiteSetting.patreon_enabled = false+ SiteSetting.patreon_api_version = "1"+ expect(described_class.new.call).to be_blank+ end+enddiff --git a/plugins/discourse-patreon/spec/spec_helper.rb b/plugins/discourse-patreon/spec/spec_helper.rbindex c5c469b0dd2..b15f1546acb 100644--- a/plugins/discourse-patreon/spec/spec_helper.rb+++ b/plugins/discourse-patreon/spec/spec_helper.rb@@ -2,12 +2,10 @@module Helpersdef get_patreon_response(filename)- FileUtils.mkdir_p("#{Rails.root}/tmp/spec") unless Dir.exist?("#{Rails.root}/tmp/spec")- FileUtils.cp(- "#{Rails.root}/plugins/discourse-patreon/spec/fixtures/#{filename}",- "#{Rails.root}/tmp/spec/#{filename}",- )- File.new("#{Rails.root}/tmp/spec/#{filename}").read+ dest = "#{Rails.root}/tmp/spec/#{filename}"+ FileUtils.mkdir_p(File.dirname(dest))+ FileUtils.cp("#{Rails.root}/plugins/discourse-patreon/spec/fixtures/#{filename}", dest)+ File.new(dest).readendend