docs: modularize rest.Client

Author: boltlessengineer

Makefile

@@ -16,5 +16,5 @@ docgen:
 	lemmy-help lua/rest-nvim/config/init.lua > doc/rest-nvim-config.txt
 	lemmy-help lua/rest-nvim/cookie_jar.lua > doc/rest-nvim-cookies.txt
 	lemmy-help lua/rest-nvim/script.lua > doc/rest-nvim-script.txt
-	lemmy-help lua/rest-nvim/api.lua lua/rest-nvim/ui/result.lua lua/rest-nvim/utils.lua > doc/rest-nvim-api.txt
+	lemmy-help lua/rest-nvim/api.lua lua/rest-nvim/client/init.lua lua/rest-nvim/ui/result.lua lua/rest-nvim/utils.lua > doc/rest-nvim-api.txt
 	lemmy-help lua/rest-nvim/client/curl/cli.lua lua/rest-nvim/client/curl/utils.lua > doc/rest-nvim-client-curl.txt

doc/rest-nvim-api.txt

@@ -45,6 +45,69 @@ api.register_rest_subcommand({name}, {cmd})
         {cmd}   (RestCmd)
 
 
+==============================================================================
+rest.nvim client module                                       *rest-nvim.client*
+
+
+ Mainly about `rest.Client` type requirements
+
+
+rest.Client                                                        *rest.Client*
+    Client to send request
+
+
+client:request({req})                                           *client:request*
+    Sends request and return the response asynchronously
+
+    Parameters: ~
+        {req}  (rest.Request)
+
+    Returns: ~
+        (nio.control.Future)  Future containing `rest.Response`
+
+
+==============================================================================
+rest.nvim result UI module                                 *rest-nvim.ui.result*
+
+
+ rest.nvim result UI implmentation
+
+
+rest.UIData                                                        *rest.UIData*
+    data used to render the UI
+
+
+ui.stat_winbar()                                                *ui.stat_winbar*
+    Winbar component showing response statistics
+
+    Returns: ~
+        (string)
+
+
+ui.is_open()                                                        *ui.is_open*
+    Check if UI window is shown in current tabpage
+
+    Returns: ~
+        (boolean)
+
+
+ui.enter({winnr})                                                     *ui.enter*
+
+    Parameters: ~
+        {winnr}  (integer)
+
+
+ui.clear()                                                            *ui.clear*
+    Clear the UI
+
+
+ui.update({new_data})                                                *ui.update*
+    Update data and rerender the UI
+
+    Parameters: ~
+        {new_data}  (rest.UIData)
+
+
 ==============================================================================
 rest.nvim utilities                                            *rest-nvim.utils*
 

doc/rest-nvim-client-curl.txt

@@ -7,13 +7,13 @@ rest.nvim cURL cli client                            *rest-nvim.client.curl.cli*
 
 
 curl.request({request})                                           *curl.request*
-    returns future containing Result
+    Send request via `curl` cli
 
     Parameters: ~
         {request}  (rest.Request)  Request data to be passed to cURL
 
     Returns: ~
-        (nio.control.Future)  future containing rest.Response
+        (nio.control.Future)  Future containing rest.Response
 
 
 utils.curl_error({code})                                      *utils.curl_error*

doc/rest-nvim-commands.txt

@@ -29,7 +29,7 @@ rest.nvim commands                                          *rest-nvim.commands*
  env set {path}                  Register environment file to current `.http` file.
                                  `path` should be relative to Neovim's cwd
 
- NOTE: All `:Rest` commands opening new window supports |command-modifiers|.
+ NOTE: All `:Rest` commands opening new window support |command-modifiers|.
  For example, you can run `:hor Rest open` to open result pane in horizontal
  split
 

lua/rest-nvim/client/curl/cli.lua

@@ -300,9 +300,9 @@ function builder.build(req)
   return vim.iter(args):flatten(math.huge):totable()
 end
 
----returns future containing Result
+---Send request via `curl` cli
 ---@param request rest.Request Request data to be passed to cURL
----@return nio.control.Future future future containing rest.Response
+---@return nio.control.Future future Future containing rest.Response
 function curl.request(request)
   local progress_handle = progress.handle.create({
     title = "Fetching",

lua/rest-nvim/client/curl/libcurl.lua

@@ -1,4 +1,4 @@
----@mod rest-nvim.client.curl.libcurl rest.nvim cURL client
+---@mod rest-nvim.client.curl.libcurl rest.nvim cURL client using libcurl (deprecated)
 ---
 ---@brief [[
 ---

lua/rest-nvim/client/curl_cli.lua

@@ -0,0 +1,8 @@
+local curl_cli = require("rest-nvim.client.curl.cli")
+
+---@type rest.Client
+local client = {
+  request = curl_cli.request
+}
+
+return client

lua/rest-nvim/client/init.lua

@@ -0,0 +1,22 @@
+---@mod rest-nvim.client rest.nvim client module
+---
+---@brief [[
+---
+--- Mainly about `rest.Client` type requirements
+---
+---@brief ]]
+
+---Client to send request
+---@class rest.Client
+local client = {}
+
+---Sends request and return the response asynchronously
+---@param req rest.Request
+---@return nio.control.Future future Future containing `rest.Response`
+function client:request(req)
+  local future = require("nio").control.future()
+  vim.print(req)
+  return future
+end
+
+return client

lua/rest-nvim/request.lua

@@ -31,7 +31,20 @@ local rest_nvim_last_request = nil
 ---@param req rest.Request
 local function run_request(req)
   logger.debug("run_request")
-  local client = require("rest-nvim.client.curl.cli")
+  ---@type rest.Client
+  local client
+  if req.method == "WEBSOCKET" then
+    logger.error("method: websocket isn't supported yet")
+    return
+  elseif req.method == "GRPC" then
+    logger.error("method: grpc isn't supported yet")
+    return
+  elseif req.method == "GRAPHQL" then
+    logger.error("method: graphql isn't supported yet")
+    return
+  else
+    client = require("rest-nvim.client.curl.cli")
+  end
   rest_nvim_last_request = req
 
   _G.rest_request = req

lua/rest-nvim/ui/result.lua

@@ -1,3 +1,11 @@
+---@mod rest-nvim.ui.result rest.nvim result UI module
+---
+---@brief [[
+---
+--- rest.nvim result UI implmentation
+---
+---@brief ]]
+
 local ui = {}
 
 local config = require("rest-nvim.config")
@@ -19,6 +27,7 @@ local function syntax_highlight(buffer, filetype)
   end
 end
 
+---data used to render the UI
 ---@class rest.UIData
 local data = {
   ---@type rest.Request?