Skip to content

A platform for community discussion. Free, open, simple.

FEATURE: Add API scope for Discourse Assign (#42760)

tshenry1ecd75d21b2f
diff --git a/plugins/discourse-assign/config/locales/client.en.yml b/plugins/discourse-assign/config/locales/client.en.yml
index 3ac5d4c2d2c..d16086e1d0d 100644
--- a/plugins/discourse-assign/config/locales/client.en.yml
+++ b/plugins/discourse-assign/config/locales/client.en.yml
@@ -1,6 +1,11 @@
en:
admin_js:
admin:
+ api:
+ scopes:
+ descriptions:
+ assign:
+ assign: "Assign/Unassign topics or posts."
site_settings:
categories:
discourse_assign: "Discourse Assign"
diff --git a/plugins/discourse-assign/plugin.rb b/plugins/discourse-assign/plugin.rb
index fc878ad7ea0..a81723ed42e 100644
--- a/plugins/discourse-assign/plugin.rb
+++ b/plugins/discourse-assign/plugin.rb
@@ -882,6 +882,11 @@ after_initialize do
MessageBus.publish("/private-messages/assigned", { topic_id: topic.id }, opts)
end
+ add_api_key_scope(
+ :assign,
+ { assign: { actions: %w[discourse_assign/assign#assign discourse_assign/assign#unassign] } },
+ )
+
# Event listeners
on(:post_created) { |post| ::Assigner.auto_assign(post, force: true) }
diff --git a/plugins/discourse-assign/spec/requests/assign_controller_spec.rb b/plugins/discourse-assign/spec/requests/assign_controller_spec.rb
index be5a1118164..5791db510ae 100644
--- a/plugins/discourse-assign/spec/requests/assign_controller_spec.rb
+++ b/plugins/discourse-assign/spec/requests/assign_controller_spec.rb
@@ -196,6 +196,26 @@ RSpec.describe DiscourseAssign::AssignController do
expect(response.status).to eq(200)
expect(allowed_topic.reload.assignment).to be_blank
end
+
+ it "unassigns a topic with an API key scoped to assign -> assign" do
+ category = Fabricate(:category)
+ topic = Fabricate(:post).topic.tap { |topic| topic.update!(category: category) }
+ api_key = Fabricate(:api_key, user: admin)
+ Fabricate(:api_key_scope, resource: "assign", action: "assign", api_key_id: api_key.id)
+ Fabricate(:topic_assignment, target: topic, assigned_to: admin, assigned_by_user: admin)
+
+ put "/assign/unassign.json",
+ headers: {
+ "HTTP_API_KEY" => api_key.key,
+ "HTTP_API_USERNAME" => admin.username,
+ },
+ params: {
+ target_id: topic.id,
+ target_type: "Topic",
+ }
+
+ expect(response.status).to eq(200)
+ end
end
describe "#assign" do
@@ -524,6 +544,26 @@ RSpec.describe DiscourseAssign::AssignController do
),
)
end
+
+ it "assigns a topic with an API key scoped to assign -> assign" do
+ category = Fabricate(:category)
+ topic = Fabricate(:post).topic.tap { |topic| topic.update!(category: category) }
+ api_key = Fabricate(:api_key, user: admin)
+ Fabricate(:api_key_scope, resource: "assign", action: "assign", api_key_id: api_key.id)
+
+ put "/assign/assign.json",
+ headers: {
+ "HTTP_API_KEY" => api_key.key,
+ "HTTP_API_USERNAME" => admin.username,
+ },
+ params: {
+ target_id: topic.id,
+ target_type: "Topic",
+ username: admin.username,
+ }
+
+ expect(response.status).to eq(200)
+ end
end
describe "#assigned" do