A platform for community discussion. Free, open, simple.
FEATURE: Add a granular API key scope to list badges (#41086)
Régis Hanole4b7c8f05fcf
diff --git a/app/models/api_key_scope.rb b/app/models/api_key_scope.rbindex 3abbb44f78a..cc65b12cacf 100644--- a/app/models/api_key_scope.rb+++ b/app/models/api_key_scope.rb@@ -198,6 +198,9 @@ class ApiKeyScope < ActiveRecord::Base},},badges: {+ list: {+ actions: %w[badges#index admin/badges#index],+ },create: {actions: %w[admin/badges#create],},diff --git a/config/locales/client.en.yml b/config/locales/client.en.ymlindex a7f9506eaab..60561367abe 100644--- a/config/locales/client.en.yml+++ b/config/locales/client.en.yml@@ -7542,6 +7542,7 @@ en:invites:create: Send email invites or generate invite links.badges:+ list: Get a list of badges.create: Create a new badge.show: Obtain information about a badge.update: Update a badge.diff --git a/spec/requests/admin/badges_controller_spec.rb b/spec/requests/admin/badges_controller_spec.rbindex abf2b7d5e05..fc16a55bb63 100644--- a/spec/requests/admin/badges_controller_spec.rb+++ b/spec/requests/admin/badges_controller_spec.rb@@ -36,6 +36,35 @@ RSpec.describe Admin::BadgesController doinclude_examples "badges inaccessible"end++ context "with an API key scoped to badges -> list" do+ it "allows an admin's key to list badges" do+ api_key = Fabricate(:api_key, user: admin)+ Fabricate(:api_key_scope, resource: "badges", action: "list", api_key_id: api_key.id)++ get "/admin/badges.json",+ headers: {+ "HTTP_API_KEY" => api_key.key,+ "HTTP_API_USERNAME" => admin.username,+ }++ expect(response.status).to eq(200)+ expect(response.parsed_body["badges"]).to be_present+ end++ it "denies a non-admin's key, since the admin route stays admin-only" do+ api_key = Fabricate(:api_key, user: user)+ Fabricate(:api_key_scope, resource: "badges", action: "list", api_key_id: api_key.id)++ get "/admin/badges.json",+ headers: {+ "HTTP_API_KEY" => api_key.key,+ "HTTP_API_USERNAME" => user.username,+ }++ expect(response.status).to eq(404)+ end+ endenddescribe "#preview" dodiff --git a/spec/requests/badges_controller_spec.rb b/spec/requests/badges_controller_spec.rbindex db46f690ca6..5611d35d7c7 100644--- a/spec/requests/badges_controller_spec.rb+++ b/spec/requests/badges_controller_spec.rb@@ -83,6 +83,45 @@ RSpec.describe BadgesController doexpect(badge_ids).not_to include(disabled_badge.id)expect(badge_ids).not_to include(non_listable_badge.id)end++ context "with an API key" do+ let(:api_key) { Fabricate(:api_key, user:) }++ def list_badges+ get "/badges.json",+ headers: {+ "HTTP_API_KEY" => api_key.key,+ "HTTP_API_USERNAME" => user.username,+ }+ end++ it "allows listing badges with the badges -> list scope" do+ Fabricate(:api_key_scope, resource: "badges", action: "list", api_key_id: api_key.id)++ list_badges++ expect(response.status).to eq(200)+ expect(response.parsed_body["badges"]).to be_present+ end++ it "denies listing badges with a non-matching scope" do+ Fabricate(:api_key_scope, resource: "badges", action: "show", api_key_id: api_key.id)++ list_badges++ expect(response.status).to eq(403)+ end++ it "allows listing badges with the badges -> list scope when login is required" do+ SiteSetting.login_required = true+ Fabricate(:api_key_scope, resource: "badges", action: "list", api_key_id: api_key.id)++ list_badges++ expect(response.status).to eq(200)+ expect(response.parsed_body["badges"]).to be_present+ end+ endenddescribe "#show" do