add deserialize_file() (#51)

* add deserialize_file()

* change version number

* remove overwrite

* add extract_filename()

Author: NeroBlackstone

Project.toml

@@ -4,7 +4,7 @@ keywords = ["Swagger", "OpenAPI", "REST"]
 license = "MIT"
 desc = "OpenAPI server and client helper for Julia"
 authors = ["JuliaHub Inc."]
-version = "0.1.14"
+version = "0.1.15"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
@@ -13,6 +13,7 @@ Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 LibCURL = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
+MIMEs = "6c6e2e6c-3030-632d-7369-2d6c69616d65"
 MbedTLS = "739be429-bea8-5141-9913-cc70e7f3736d"
 TimeZones = "f269a46b-ccf7-5d73-abea-4c690281aa53"
 URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
@@ -26,14 +27,15 @@ MbedTLS = "0.6.8, 0.7, 1"
 TimeZones = "1"
 URIs = "1.3"
 julia = "1.6"
+MIMEs = "0.1"
 
 [extras]
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
-HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
-Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 TimeZones = "f269a46b-ccf7-5d73-abea-4c690281aa53"
+URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
 
 [targets]
 test = ["Test", "Random", "URIs", "HTTP", "Dates", "TimeZones"]

src/client.jl

@@ -8,6 +8,7 @@ using Dates
 using TimeZones
 using LibCURL
 using HTTP
+using MIMEs
 
 import Base: convert, show, summary, getproperty, setproperty!, iterate
 import ..OpenAPI: APIModel, UnionAPIModel, OneOfAPIModel, AnyOfAPIModel, APIClientImpl, OpenAPIException, InvocationException, to_json, from_json, validate_property, property_type
@@ -599,4 +600,50 @@ is_request_interrupted(ex::TaskFailedException) = is_request_interrupted(ex.task
 is_request_interrupted(ex::CompositeException) = any(is_request_interrupted, ex.exceptions)
 is_request_interrupted(ex::InvocationException) = ex.reason == "request was interrupted"
 
+
+"""
+    deserialize_file(api_call::Function;
+        folder_path::String=pwd(),
+        rename_file::String="",
+        overwrite::Bool=true
+        )::Tuple{Any,ApiResponse,String}
+
+    Saves response body into a file in a temporary folder,
+    using the filename from the `Content-Disposition` header if provided.
+    - `api_call`: API function that return `(result, http_response)` Tuple.
+    - `folder_path`: file save location, default value is `pwd()``.
+    - `rename_file`: rename the file, default value is `""`.
+    - return: (result, http_response, file_path).
+"""
+function deserialize_file(api_call::Function;
+    folder_path::String=pwd(),
+    rename_file::String="",
+    )::Tuple{Any,ApiResponse,String}
+    
+    result, http_response = api_call()
+
+    content_disposition_str = OpenAPI.Clients.header(http_response.raw,"content-disposition","")
+    content_type_str = extract_filename(OpenAPI.Clients.header(http_response.raw,"content-type",""))
+    
+    file_name = if !isempty(rename_file)
+        rename_file
+    elseif !isempty(content_disposition_str)
+        content_disposition_str
+    else 
+        "response"*extension_from_mime(MIME(content_type_str))
+    end
+
+    file_path = joinpath(mkpath(folder_path),file_name)
+    open(file_path,"w") do file
+        write(file,result)
+    end
+    return result, http_response, file_path
+end
+
+# extract_filename from content-disposition
+function extract_filename(str::String)::String
+    m = match(r"filename=\"(.*?)\"",str)
+    return isnothing(m) ? "" : m.captures[1]
+end
+
 end # module Clients