feat: interpret basic authorization token

Add request hook to convert "Authorization: Basic username:passeord" to
"Authorization: Basic <base64-encoded>" before reqeust.

Author: boltlessengineer

README.md

@@ -125,6 +125,9 @@ local default_config = {
             user_agent = "rest.nvim v" .. require("rest-nvim.api").VERSION,
             ---@type boolean Set `Content-Type` header when it is empty and body is provided
             set_content_type = true,
+            ---@type boolean Interpret `Authorization` header when it is set in form of
+            ---"Basic username:password" or "Basic username password"
+            interpret_basic_auth = true,
         },
     },
     ---@class rest.Config.Response

doc/rest-nvim.txt

@@ -149,10 +149,14 @@ rest.Opts.Request                                            *rest.Opts.Request*
 rest.Opts.Request.Hooks                                *rest.Opts.Request.Hooks*
 
     Fields: ~
-        {encode_url?}        (boolean)   Encode URL before making request (Default: `true`)
-        {user_agent?}        (string)    Set `User-Agent` header when it is empty. Set as empty string to disable.
-                                         (Default: `rest.nvim {version}`)
-        {set_content_type?}  (boolean)   Set `Content-Type` header when it is empty but request body is provided
+        {encode_url?}            (boolean)   Encode URL before making request (Default: `true`)
+        {user_agent?}            (string)    Set `User-Agent` header when it is empty. Set as empty string to disable.
+                                             (Default: `rest.nvim {version}`)
+        {set_content_type?}      (boolean)   Set `Content-Type` header when it is empty but request body is provided
+        {interpret_basic_auth?}  (boolean)   Interpret `Authorization` header when it is set in form of
+                                             "Basic username:password" or "Basic username password"
+                                             It will convert header to "Basic <base64-encoded-username:password>"
+                                             (Default: `true`)
 
 
 rest.Opts.Response                                          *rest.Opts.Response*

lua/rest-nvim/autocmds.lua

@@ -81,6 +81,14 @@ function autocmds.setup()
                     end
                 end
             end
+            if hooks.interpret_basic_auth then
+                local auth_header = req.headers["authorization"]
+                if auth_header then
+                    local auth_header_value = auth_header[#auth_header]
+                    local id, pw = auth_header_value:match("Basic%s+([^:%s]+)%s*[:(%s+)]%s*(.*)")
+                    auth_header[#auth_header] = "Basic " .. require("base64").encode(id .. ":" .. pw)
+                end
+            end
         end,
     })
     vim.api.nvim_create_autocmd("User", {

lua/rest-nvim/config/default.lua

@@ -19,6 +19,9 @@ local default_config = {
             user_agent = "rest.nvim v" .. require("rest-nvim.api").VERSION,
             ---@type boolean Set `Content-Type` header when it is empty and body is provided
             set_content_type = true,
+            ---@type boolean Interpret `Authorization` header when it is set in form of
+            ---"Basic username:password" or "Basic username password"
+            interpret_basic_auth = true,
         },
     },
     ---@class rest.Config.Response

lua/rest-nvim/config/init.lua

@@ -43,6 +43,11 @@ local config
 ---@field user_agent? string
 --- Set `Content-Type` header when it is empty but request body is provided
 ---@field set_content_type? boolean
+--- Interpret `Authorization` header when it is set in form of
+--- "Basic username:password" or "Basic username password"
+--- It will convert header to "Basic <base64-encoded-username:password>"
+--- (Default: `true`)
+---@field interpret_basic_auth? boolean
 
 ---@class rest.Opts.Response
 --- Default response hooks (aka. request handlers) configuration

nix/plugin-overlay.nix

@@ -1,6 +1,25 @@
 { self }: final: prev: let
   luaPackages-override = luaself: luaprev: {
     tree-sitter-http = luaself.callPackage ./tree-sitter-http.nix {};
+    base64 = luaself.callPackage ({
+      buildLuarocksPackage,
+      fetchurl,
+      fetchzip,
+      luaOlder,
+    }:
+      buildLuarocksPackage {
+        pname = "base64";
+        version = "1.5-3";
+        knownRockspec = (fetchurl {
+          url    = "mirror://luarocks/base64-1.5-3.rockspec";
+          sha256 = "sha256-jMWugDDJMOfapPyEWVrC2frF24MSr8pLsNtwK9ejLwM=";
+        }).outPath;
+        src = fetchzip {
+          url    = "https://github.com/iskolbin/lbase64/archive/c261320edbdf82c16409d893a96c28c704aa0ab8.zip";
+          sha256 = "sha256-Ucu7pxEbyeUyV12+FeFbGNhXiKsGYlXFMrb1Vhsnfrc=";
+        };
+        disabled = luaOlder "5.1";
+      }) {};
     rest-nvim = luaself.callPackage ({
       buildLuarocksPackage,
       fetchurl,
@@ -19,6 +38,7 @@
           mimetypes
           xml2lua
           fidget-nvim
+          base64
           tree-sitter-http
         ];
       }) {};

nix/test-overlay.nix

@@ -14,6 +14,7 @@
           mimetypes
           xml2lua
           fidget-nvim
+          final.lua51Packages.base64
           final.lua51Packages.tree-sitter-http
         ];
       extraPackages = [

rest.nvim-scm-1.rockspec

@@ -25,6 +25,7 @@ dependencies = {
   "mimetypes",
   "xml2lua",
   "fidget.nvim",
+  "base64",
   "tree-sitter-http == 0.0.35",
 }
 

spec/examples/examples_spec.lua

@@ -119,4 +119,42 @@ describe("builtin request hooks", function()
             assert.same({ "application/json" }, req.headers["content-type"])
         end)
     end)
+    ---@return rest.Request
+    local function sample_request(opts)
+        return vim.tbl_deep_extend("keep", opts, {
+            method = "GET",
+            url = "https://example.com",
+            headers = {},
+            cookies = {},
+            handlers = {},
+        })
+    end
+    describe("interpret_basic_auth", function()
+        it("with valid vscode style token", function()
+            local req = sample_request({
+                headers = {
+                    ["authorization"] = { "Basic username:password" },
+                },
+            })
+            _G.rest_request = req
+            vim.api.nvim_exec_autocmds("User", {
+                pattern = { "RestRequest", "RestRequestPre" },
+            })
+            _G.rest_request = nil
+            assert.same({ "Basic dXNlcm5hbWU6cGFzc3dvcmQ=" }, req.headers["authorization"])
+        end)
+        it("with valid intellij style token", function()
+            local req = sample_request({
+                headers = {
+                    ["authorization"] = { "Basic username password" },
+                },
+            })
+            _G.rest_request = req
+            vim.api.nvim_exec_autocmds("User", {
+                pattern = { "RestRequest", "RestRequestPre" },
+            })
+            _G.rest_request = nil
+            assert.same({ "Basic dXNlcm5hbWU6cGFzc3dvcmQ=" }, req.headers["authorization"])
+        end)
+    end)
 end)