package ez_api
Easy API library and tools
Install
dune-project
Dependency
Authors
Maintainers
Sources
3.0.0.tar.gz
md5=9069f59ac83c958cedc90a25f24faa1e
sha512=4b066a759043e6704a9617bdc412d29f7ded058cb0e01eb3a8207f54b80bebb478bb98a96832e61b15d281bc8f132e1386459c563eb807a51c01324541fe28b2
doc/src/ez_api.request/ezRequest.ml.html
Source file ezRequest.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184(**************************************************************************) (* *) (* Copyright 2018-2023 OCamlPro *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) open EzAPI open EzRequest_common module type S = EzReq_S.S module type Interface = EzReq_S.Interface let request_reply_hook = ref (fun () -> ()) let before_hook = ref (fun () -> ()) let decode_result ?error io f res = match IO.from_string io f res with | Ok () -> () | Error (`destruct_exn exn) -> match error with | None -> () | Some error -> let msg = match exn with | Json_encoding.Cannot_destruct _ -> Json_encoding.print_error Format.str_formatter exn; Format.flush_str_formatter () | _ -> Printexc.to_string exn in error (-3) (Some msg) let any_get = ref (fun ?meth:_m ?headers:_ ?msg:_ _url f -> f (Error (-2,Some "No http client loaded"))) let any_post = ref (fun ?meth:_m ?content_type:(_x="") ?content:(_y="") ?headers:_ ?msg:_ _url f -> f (Error (-2,Some "No http client loaded"))) module Make(S : Interface) : S = struct let init () = any_get := S.get; any_post := S.post let internal_get ?meth ?headers ?msg ?error ~ok (URL url) = EzAPI.warnings (Format.eprintf "EzRequest.warning: %s"); let meth = match meth with None -> None | Some m -> Some (String.uppercase_ascii @@ Meth.to_string m) in let headers = add_user_agent ?headers () in S.get ?meth ?msg url ?headers (fun code -> !request_reply_hook (); match code with | Ok res -> ok res | Error (n, body) -> match error with | None -> () | Some f -> f n body) let internal_post ?meth ?headers ?msg ?error ~ok ?content_type ?content (URL url) = EzAPI.warnings (Format.eprintf "EzRequest.warning: %s"); let meth = match meth with None -> None | Some m -> Some ( String.uppercase_ascii @@ Meth.to_string m) in let headers = add_user_agent ?headers () in S.post ?meth ?content_type ?content ?headers ?msg url (fun code -> !request_reply_hook (); match code with | Ok res -> ok res | Error (n, body) -> match error with | None -> () | Some f -> f n body) let add_hook f = let old_hook = !before_hook in before_hook := (fun () -> old_hook (); f ()) let add_reply_hook f = let old_hook = !request_reply_hook in request_reply_hook := (fun () -> old_hook (); f ()) let handlers ?error service f = let error code msg = match Service.error service ~code, msg with | Some enc, Some s -> decode_result ?error (Json enc) (fun x -> f (Error x)) s | _, _ -> match error with | Some error -> error code msg (* unhandled *) | None -> () in let encoding = Service.output service in let ok = decode_result ~error encoding (fun x -> f (Ok x)) in ok, error let get ?meth ?headers ?msg ?error url f = internal_get ?meth ?headers ?msg ?error ~ok:f url let post ?meth ?content_type ?content ?headers ?msg ?error url f = internal_post ?meth ?content_type ?content ?headers ?msg ?error ~ok:f url module Raw = struct let request ?headers ?params ?msg ?post ?url_encode ?error ~input api service arg f = !before_hook (); let ok, error = handlers ?error service.s f in let meth = Service.meth service.s in handle_input ?params ?post ?url_encode ~input api service arg (internal_get ~meth ?headers ?msg ~error ~ok, internal_post ~meth ?headers ?msg ~error ~ok) let get0 ?post ?headers ?params ?msg ?error api service f = request ?headers ?params ?msg ?post ?error ~input:() api service Req.dummy f let get1 ?post ?headers ?params ?msg ?error api service arg f = request ?headers ?params ?msg ?post ?error ~input:() api service (Req.dummy, arg) f let get2 ?post ?headers ?params ?msg ?error api service arg1 arg2 f = request ?headers ?params ?msg ?post ?error ~input:() api service ((Req.dummy, arg1), arg2) f let post0 ?headers ?params ?msg ?url_encode ?error ~input api service f = request ?headers ?params ?msg ?url_encode ?error ~input api service Req.dummy f let post1 ?headers ?params ?msg ?url_encode ?error ~input api service arg f = request ?headers ?params ?msg ?url_encode ?error ~input api service (Req.dummy, arg) f let post2 ?headers ?params ?msg ?url_encode ?error ~input api service arg1 arg2 f = request ?headers ?params ?msg ?url_encode ?error ~input api service ((Req.dummy, arg1), arg2) f end include Raw module Legacy = struct let unresultize f = function | Ok res -> f res | Error _u -> assert false (* Security.unreachable u *) let get0 api service msg ?post ?headers ?error ?params f () = let msg = if msg = "" then None else Some msg in Raw.get0 api service ?msg ?post ?headers ?error ?params (unresultize f) let get1 api service msg ?post ?headers ?error ?params f arg = let msg = if msg = "" then None else Some msg in Raw.get1 api service ?msg ?post ?headers ?error ?params arg (unresultize f) let get2 api service msg ?post ?headers ?error ?params f arg1 arg2 = let msg = if msg = "" then None else Some msg in Raw.get2 api service ?msg ?post ?headers ?error ?params arg1 arg2 (unresultize f) let post0 api service msg ?headers ?error ?params ?url_encode ~input f = let msg = if msg = "" then None else Some msg in Raw.post0 api service ?msg ?headers ?error ?params ?url_encode ~input (unresultize f) let post1 api service msg ?headers ?error ?params ?url_encode ~input arg f = let msg = if msg = "" then None else Some msg in Raw.post1 api service ?msg ?headers ?error ?params ?url_encode ~input arg (unresultize f) let post2 api service msg ?headers ?error ?params ?url_encode ~input arg1 arg2 f = let msg = if msg = "" then None else Some msg in Raw.post2 api service ?msg ?headers ?error ?params ?url_encode ~input arg1 arg2 (unresultize f) let get ?meth msg url ?headers ?error f = let msg = if msg = "" then None else Some msg in get ?meth ?headers ?msg ?error url f let post ?meth ?content_type ?content msg url ?headers ?error f = let msg = if msg = "" then None else Some msg in post ?meth ?content_type ?content ?headers ?msg ?error url f end end module ANY : S = Make(struct let get ?meth ?headers ?msg url f = !any_get ?meth ?msg url ?headers f let post ?meth ?content_type ?content ?headers ?msg url f = !any_post ?meth ?content_type ?content ?msg url ?headers f end)