[feat] Response body stored (only for JSON responses)

lua/rest-nvim/curl/init.lua

@@ -51,7 +51,7 @@ M.get_or_create_buf = function()
   return new_bufnr
 end
 
-local function create_callback(method, url, script_str)
+local function create_callback(method, url, script_str, req_var)
   return function(res)
     if res.exit ~= 0 then
       log.error("[rest.nvim] " .. utils.curl_error(res.exit))
@@ -148,6 +148,13 @@ local function create_callback(method, url, script_str)
         }, false, {})
       end
     end
+    -- check if the response is a json
+    -- parse the json response and store the data on memory
+    if content_type == "json" and req_var ~= "" then
+      local req_var_store = vim.api.nvim_get_var("req_var_store")
+      req_var_store[req_var] = vim.json.decode(res.body)
+      vim.api.nvim_set_var("req_var_store", req_var_store)
+    end
 
     -- append response container
     res.body = "#+RESPONSE\n" .. res.body .. "\n#+END"
@@ -227,7 +234,8 @@ M.curl_cmd = function(opts)
     vim.api.nvim_echo({ { "[rest.nvim] Request preview:\n", "Comment" }, { curl_cmd } }, false, {})
     return
   else
-    opts.callback = vim.schedule_wrap(create_callback(opts.method, opts.url, opts.script_str))
+    opts.callback =
+      vim.schedule_wrap(create_callback(opts.method, opts.url, opts.script_str, opts.req_var))
     curl[opts.method](opts)
   end
 end

lua/rest-nvim/init.lua

@@ -7,6 +7,7 @@ local rest = {}
 local Opts = {}
 local LastOpts = {}
 
+vim.api.nvim_set_var("req_var_store", { __loaded = true })
 rest.setup = function(user_configs)
   config.set(user_configs or {})
 end
@@ -74,6 +75,7 @@ rest.run_request = function(req, opts)
     bufnr = result.bufnr,
     start_line = result.start_line,
     end_line = result.end_line,
+    req_var = result.req_var,
     script_str = result.script_str,
   }
 

lua/rest-nvim/request/init.lua

@@ -21,7 +21,7 @@ local function get_importfile_name(bufnr, start_line, stop_line)
     local fileimport_spliced
     fileimport_line = vim.api.nvim_buf_get_lines(bufnr, import_line - 1, import_line, false)
     fileimport_string =
-    string.gsub(fileimport_line[1], "<", "", 1):gsub("^%s+", ""):gsub("%s+$", "")
+      string.gsub(fileimport_line[1], "<", "", 1):gsub("^%s+", ""):gsub("%s+$", "")
     fileimport_spliced = utils.replace_vars(fileimport_string)
     if path:new(fileimport_spliced):is_absolute() then
       return fileimport_spliced
@@ -89,7 +89,6 @@ local function get_body(bufnr, start_line, stop_line, has_json)
     end
   end
 
-
   return body
 end
 
@@ -226,6 +225,19 @@ local function start_request(bufnr, linenumber)
   return res
 end
 
+-- request_var will find the request variable if it exists, e.g.
+-- ```
+-- #@foo
+-- GET http://localhost:8081/bar
+-- ````
+-- of the current request and returns the linenumber of the found request variable
+-- the request variable is defined as the variable that starts with '#@'
+-- one line above the request line in the example the variable would be 'foo'
+-- @param url_line The request line
+local function request_var(url_line)
+  return vim.fn.search("^#@", "cbn", url_line - 1)
+end
+
 -- end_request will find the next request line (e.g. POST http://localhost:8081/foo)
 -- and returns the linenumber before this request line or the end of the buffer
 -- @param bufnr The buffer nummer of the .http-file
@@ -240,8 +252,8 @@ local function end_request(bufnr, linenumber)
   end
   utils.move_cursor(bufnr, linenumber)
 
-  local next = vim.fn.search("^GET\\|^POST\\|^PUT\\|^PATCH\\|^DELETE\\|^###\\", "cn",
-    vim.fn.line("$"))
+  local next =
+    vim.fn.search("^GET\\|^POST\\|^PUT\\|^PATCH\\|^DELETE\\|^###\\", "cn", vim.fn.line("$"))
 
   -- restore cursor position
   utils.move_cursor(bufnr, oldlinenumber)
@@ -286,6 +298,14 @@ local function parse_url(stmt)
   }
 end
 
+-- parse_req_var returns a string with the name of the request variable, e.g.
+-- #@foo -> parse_req_var -> foo
+-- @param stmt the request variable (#@foo)
+local function parse_req_var(stmt)
+  local parsed = stmt:sub(3)
+  return parsed
+end
+
 local M = {}
 M.get_current_request = function()
   return M.buf_get_request(vim.api.nvim_win_get_buf(0), vim.fn.getcurpos())
@@ -308,6 +328,12 @@ M.buf_get_request = function(bufnr, curpos)
 
   local parsed_url = parse_url(vim.fn.getline(start_line))
 
+  local req_var_line = request_var(start_line)
+  local parsed_req_var_str = ""
+  if req_var_line ~= 0 then
+    parsed_req_var_str = parse_req_var(vim.fn.getline(req_var_line))
+  end
+
   local headers, headers_end = get_headers(bufnr, start_line, end_line)
 
   local curl_args, body_start = get_curl_args(bufnr, headers_end, end_line)
@@ -328,35 +354,30 @@ M.buf_get_request = function(bufnr, curpos)
     end
   end
 
-  local body = get_body(
-    bufnr,
-    body_start,
-    end_line,
-    content_type:find("application/[^ ]*json")
-  )
+  local body = get_body(bufnr, body_start, end_line, content_type:find("application/[^ ]*json"))
 
   local script_str = get_response_script(bufnr, headers_end, end_line)
 
-
   if config.get("jump_to_request") then
     utils.move_cursor(bufnr, start_line)
   else
     utils.move_cursor(bufnr, curpos[2], curpos[3])
   end
 
   return true,
-      {
-        method = parsed_url.method,
-        url = parsed_url.url,
-        http_version = parsed_url.http_version,
-        headers = headers,
-        raw = curl_args,
-        body = body,
-        bufnr = bufnr,
-        start_line = start_line,
-        end_line = end_line,
-        script_str = script_str
-      }
+    {
+      method = parsed_url.method,
+      url = parsed_url.url,
+      http_version = parsed_url.http_version,
+      headers = headers,
+      raw = curl_args,
+      body = body,
+      bufnr = bufnr,
+      start_line = start_line,
+      end_line = end_line,
+      script_str = script_str,
+      req_var = parsed_req_var_str,
+    }
 end
 
 M.print_request = function(req)

lua/rest-nvim/utils/init.lua

@@ -207,10 +207,13 @@ M.read_document_variables = function()
 
   for node in root:iter_children() do
     local type = node:type()
+
     if type == "header" then
       local name = node:named_child(0)
       local value = node:named_child(1)
-      variables[M.get_node_value(name, bufnr)] = M.get_node_value(value, bufnr)
+      -- check if variable has assigned other variable, e.g. foo: {{bar}}
+      local value_processed = M.replace_req_varibles(M.get_node_value(value, bufnr))
+      variables[M.get_node_value(name, bufnr)] = value_processed
     elseif type ~= "comment" then
       break
     end
@@ -226,6 +229,51 @@ M.read_variables = function()
   return vim.tbl_extend("force", first, second, third)
 end
 
+-- replaces the variables that have assigned another variable, e.g. foo: {{bar}} or foo: {{bar.baz}}
+-- if so, then replace {{bar}} or {{bar.baz}} with the proper value else return the same string
+-- only works if `bar` is a key in req_var_store
+-- @param value_str the value to evaluate
+M.replace_req_varibles = function(value_str)
+  -- first check if 'value_str' has the form {{bar}} if not then return them as is
+  local match = string.match(value_str, "{{[^}]+}}")
+  if match == nil then
+    return value_str
+  end
+
+  match = match:gsub("{", ""):gsub("}", "")
+
+  -- split the value_str, e.g. 'foo.bar.baz' -> {'foo', 'bar', 'baz'}
+  local splitted_values = {}
+  for var in match:gmatch("([^.]+)") do
+    -- try to parse 'var' as number
+    local x = tonumber(var)
+    if x then
+      var = x + 1
+    end
+    table.insert(splitted_values, var)
+  end
+
+  local result = vim.api.nvim_get_var("req_var_store")
+  if not result.__loaded then
+    error(
+      string.format(
+        "rest-nvim's global JSON variable has been unset, it is needed to get %s from there",
+        match
+      )
+    )
+  end
+  for _, val in pairs(splitted_values) do
+    if result[val] then
+      result = result[val]
+    else
+      result = ""
+      break
+    end
+  end
+
+  return result
+end
+
 -- replace_vars replaces the env variables fields in the provided string
 -- with the env variable value
 -- @param str Where replace the placers for the env variables

tests/request_vars/basic_usage.http

@@ -0,0 +1,17 @@
+page: {{response.page}}
+url: {{response.support.url}}
+userid: {{response.data.0.id}}
+
+# normal var
+foo: 4
+
+#@response
+GET https://reqres.in/api/users?page=2
+
+GET https://reqres.in/api/users?page={{foo}}
+
+GET https://reqres.in/api/users?page={{page}}
+
+GET {{url}}
+
+GET https://reqres.in/api/users/{{userid}}