discourse/app/models/user_api_key_scope.rb

68 lines
1.9 KiB
Ruby

# frozen_string_literal: true
class UserApiKeyScope < ActiveRecord::Base
SCOPES = {
read: [RouteMatcher.new(methods: :get)],
write: [RouteMatcher.new(methods: %i[get post patch put delete])],
message_bus: [RouteMatcher.new(methods: :post, actions: "message_bus")],
push: [],
one_time_password: [],
notifications: [
RouteMatcher.new(methods: :post, actions: "message_bus"),
RouteMatcher.new(methods: :get, actions: "notifications#index"),
RouteMatcher.new(methods: :put, actions: "notifications#mark_read"),
],
session_info: [
RouteMatcher.new(methods: :get, actions: "session#current"),
RouteMatcher.new(methods: :get, actions: "users#topic_tracking_state"),
],
bookmarks_calendar: [
RouteMatcher.new(
methods: :get,
actions: "users#bookmarks",
formats: :ics,
params: %i[username],
),
],
user_status: [
RouteMatcher.new(methods: :get, actions: "user_status#get"),
RouteMatcher.new(methods: :put, actions: "user_status#set"),
RouteMatcher.new(methods: :delete, actions: "user_status#clear"),
],
}
def self.all_scopes
scopes = SCOPES
DiscoursePluginRegistry.user_api_key_scope_mappings.each do |mapping|
scopes = scopes.merge!(mapping)
end
scopes
end
def permits?(env)
matchers.any? { |m| m.with_allowed_param_values(allowed_parameters).match?(env: env) }
end
private
def matchers
@matchers ||= Array(self.class.all_scopes[name.to_sym])
end
end
# == Schema Information
#
# Table name: user_api_key_scopes
#
# id :bigint not null, primary key
# user_api_key_id :integer not null
# name :string not null
# created_at :datetime not null
# updated_at :datetime not null
# allowed_parameters :jsonb
#
# Indexes
#
# index_user_api_key_scopes_on_user_api_key_id (user_api_key_id)
#