commit e629173c576b33516395e70fa27994da2d0aedae · anil.recoil.org/slop

+62

stack/zulip/lib/zulip/lib/zulip_types.ml

···

       1
       1
       +
       (** Core types for Zulip API *)

     

       2
       2
       +
       

     

       3
       3
       +
       (** JSON type used throughout the API *)

     

       4
       4
       +
       type json = [`Null | `Bool of bool | `Float of float | `String of string | `A of json list | `O of (string * json) list]

     

       5
       5
       +
       

     

       6
       6
       +
       (** Error codes returned by Zulip API *)

     

       7
       7
       +
       type error_code =

     

       8
       8
       +
         | Invalid_api_key

     

       9
       9
       +
         | Request_variable_missing

     

       10
       10
       +
         | Bad_request

     

       11
       11
       +
         | User_deactivated

     

       12
       12
       +
         | Realm_deactivated

     

       13
       13
       +
         | Rate_limit_hit

     

       14
       14
       +
         | Other of string

     

       15
       15
       +
       

     

       16
       16
       +
       (** Zulip-specific error type *)

     

       17
       17
       +
       type zerror = {

     

       18
       18
       +
         code : error_code;

     

       19
       19
       +
         message : string;

     

       20
       20
       +
         extra : (string * json) list;

     

       21
       21
       +
       }

     

       22
       22
       +
       

     

       23
       23
       +
       let error_code_to_string = function

     

       24
       24
       +
         | Invalid_api_key -> "INVALID_API_KEY"

     

       25
       25
       +
         | Request_variable_missing -> "REQUEST_VARIABLE_MISSING"

     

       26
       26
       +
         | Bad_request -> "BAD_REQUEST"

     

       27
       27
       +
         | User_deactivated -> "USER_DEACTIVATED"

     

       28
       28
       +
         | Realm_deactivated -> "REALM_DEACTIVATED"

     

       29
       29
       +
         | Rate_limit_hit -> "RATE_LIMIT_HIT"

     

       30
       30
       +
         | Other s -> s

     

       31
       31
       +
       

     

       32
       32
       +
       let error_code_of_string s = match s with

     

       33
       33
       +
         | "INVALID_API_KEY" -> Invalid_api_key

     

       34
       34
       +
         | "REQUEST_VARIABLE_MISSING" -> Request_variable_missing

     

       35
       35
       +
         | "BAD_REQUEST" -> Bad_request

     

       36
       36
       +
         | "USER_DEACTIVATED" -> User_deactivated

     

       37
       37
       +
         | "REALM_DEACTIVATED" -> Realm_deactivated

     

       38
       38
       +
         | "RATE_LIMIT_HIT" -> Rate_limit_hit

     

       39
       39
       +
         | s -> Other s

     

       40
       40
       +
       

     

       41
       41
       +
       let create_error ~code ~msg ?(extra = []) () = { code; message = msg; extra }

     

       42
       42
       +
       let error_code t = t.code

     

       43
       43
       +
       let error_message t = t.message

     

       44
       44
       +
       let error_extra t = t.extra

     

       45
       45
       +
       let pp_error fmt t = Format.fprintf fmt "Error(%s): %s"

     

       46
       46
       +
         (error_code_to_string t.code) t.message

     

       47
       47
       +
       

     

       48
       48
       +
       let error_of_json json =

     

       49
       49
       +
         match json with

     

       50
       50
       +
         | `O fields ->

     

       51
       51
       +
             (try

     

       52
       52
       +
               let code_str = match List.assoc "code" fields with

     

       53
       53
       +
                 | `String s -> s

     

       54
       54
       +
                 | _ -> "OTHER" in

     

       55
       55
       +
               let msg = match List.assoc "msg" fields with

     

       56
       56
       +
                 | `String s -> s

     

       57
       57
       +
                 | _ -> "Unknown error" in

     

       58
       58
       +
               let code = error_code_of_string code_str in

     

       59
       59
       +
               let extra = List.filter (fun (k, _) -> k <> "code" && k <> "msg" && k <> "result") fields in

     

       60
       60
       +
               Some (create_error ~code ~msg ~extra ())

     

       61
       61
       +
             with Not_found -> None)

     

       62
       62
       +
         | _ -> None

+30

stack/zulip/lib/zulip/lib/zulip_types.mli

···

       1
       1
       +
       (** Core types for Zulip API *)

     

       2
       2
       +
       

     

       3
       3
       +
       (** JSON type used throughout the API *)

     

       4
       4
       +
       type json = [`Null | `Bool of bool | `Float of float | `String of string | `A of json list | `O of (string * json) list]

     

       5
       5
       +
       

     

       6
       6
       +
       (** Error codes returned by Zulip API *)

     

       7
       7
       +
       type error_code =

     

       8
       8
       +
         | Invalid_api_key

     

       9
       9
       +
         | Request_variable_missing

     

       10
       10
       +
         | Bad_request

     

       11
       11
       +
         | User_deactivated

     

       12
       12
       +
         | Realm_deactivated

     

       13
       13
       +
         | Rate_limit_hit

     

       14
       14
       +
         | Other of string

     

       15
       15
       +
       

     

       16
       16
       +
       (** Zulip-specific error type *)

     

       17
       17
       +
       type zerror = {

     

       18
       18
       +
         code : error_code;

     

       19
       19
       +
         message : string;

     

       20
       20
       +
         extra : (string * json) list;

     

       21
       21
       +
       }

     

       22
       22
       +
       

     

       23
       23
       +
       val error_code_to_string : error_code -> string

     

       24
       24
       +
       val error_code_of_string : string -> error_code

     

       25
       25
       +
       val create_error : code:error_code -> msg:string -> ?extra:(string * json) list -> unit -> zerror

     

       26
       26
       +
       val error_code : zerror -> error_code

     

       27
       27
       +
       val error_message : zerror -> string

     

       28
       28
       +
       val error_extra : zerror -> (string * json) list

     

       29
       29
       +
       val pp_error : Format.formatter -> zerror -> unit

     

       30
       30
       +
       val error_of_json : json -> zerror option