mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	Adds request as a parameter to json_success as a refactor towards making `ignored_parameters_unsupported` functionality available for all API endpoints. Also, removes any data parameters that are an empty dict or a dict with the generic success response values.
		
			
				
	
	
		
			60 lines
		
	
	
		
			1.8 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			60 lines
		
	
	
		
			1.8 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
from typing import Dict, List, Optional
 | 
						|
 | 
						|
from django.http import HttpRequest, HttpResponse
 | 
						|
 | 
						|
from zerver.lib.bot_storage import (
 | 
						|
    StateError,
 | 
						|
    get_bot_storage,
 | 
						|
    get_keys_in_bot_storage,
 | 
						|
    remove_bot_storage,
 | 
						|
    set_bot_storage,
 | 
						|
)
 | 
						|
from zerver.lib.exceptions import JsonableError
 | 
						|
from zerver.lib.request import REQ, has_request_variables
 | 
						|
from zerver.lib.response import json_success
 | 
						|
from zerver.lib.validator import check_dict, check_list, check_string
 | 
						|
from zerver.models import UserProfile
 | 
						|
 | 
						|
 | 
						|
@has_request_variables
 | 
						|
def update_storage(
 | 
						|
    request: HttpRequest,
 | 
						|
    user_profile: UserProfile,
 | 
						|
    storage: Dict[str, str] = REQ(json_validator=check_dict([], value_validator=check_string)),
 | 
						|
) -> HttpResponse:
 | 
						|
    try:
 | 
						|
        set_bot_storage(user_profile, list(storage.items()))
 | 
						|
    except StateError as e:  # nocoverage
 | 
						|
        raise JsonableError(str(e))
 | 
						|
    return json_success(request)
 | 
						|
 | 
						|
 | 
						|
@has_request_variables
 | 
						|
def get_storage(
 | 
						|
    request: HttpRequest,
 | 
						|
    user_profile: UserProfile,
 | 
						|
    keys: Optional[List[str]] = REQ(json_validator=check_list(check_string), default=None),
 | 
						|
) -> HttpResponse:
 | 
						|
    if keys is None:
 | 
						|
        keys = get_keys_in_bot_storage(user_profile)
 | 
						|
    try:
 | 
						|
        storage = {key: get_bot_storage(user_profile, key) for key in keys}
 | 
						|
    except StateError as e:
 | 
						|
        raise JsonableError(str(e))
 | 
						|
    return json_success(request, data={"storage": storage})
 | 
						|
 | 
						|
 | 
						|
@has_request_variables
 | 
						|
def remove_storage(
 | 
						|
    request: HttpRequest,
 | 
						|
    user_profile: UserProfile,
 | 
						|
    keys: Optional[List[str]] = REQ(json_validator=check_list(check_string), default=None),
 | 
						|
) -> HttpResponse:
 | 
						|
    if keys is None:
 | 
						|
        keys = get_keys_in_bot_storage(user_profile)
 | 
						|
    try:
 | 
						|
        remove_bot_storage(user_profile, keys)
 | 
						|
    except StateError as e:
 | 
						|
        raise JsonableError(str(e))
 | 
						|
    return json_success(request)
 |