rails-http-lab 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455a98547ed2be13947848e16d5225d1107b5a4cbce170ebf6b5d8bcfcdf071a
-  data.tar.gz: b38a9225af1559ad6ead838f4fede715ac4ed399fd2d9fd6c79e32787d400714
+  metadata.gz: '09a056aea1f71d9c958b238c6eb6bda36ac6cb982315bc19b540652926c05726'
+  data.tar.gz: a469930e6fc214f3ca3310581ea20210fa5bba233d3aefba9c6095bbfa55b1e9
 SHA512:
-  metadata.gz: 895dc4334974bb9bb08e07a8fdbcb3f4e8f7b50fa7b7ed846930fdd63cf49d3a9e3ec28b94167bc7cc6bf0963ba649b000eb89f51c2fd4daf41a3fec9dbf90a2
-  data.tar.gz: 84f1c94df54f49893c87e0790de96acc2d574eddf9d664222e08d6ea4866a0994f831099c630fd76e2358059093d143fb23edd83aabc50f567c5988c599cf7bb
+  metadata.gz: b1f002fe432bd2ba8ea8757b26c83d1614bd27f665155493596bbcfe90feeb28fb4eb6ef9ad454d71480df37daab8ea50a3aff4308473da3cd730803af6d8aab
+  data.tar.gz: 1771183d8b275004bb49e393d1d9b631df83e76ed6f5962d7ca51071d20f311acfd1910c9963013b8c5a8919587f5b57d6b91d202d4e15c11cd857e70cb03956

data/README.md

@@ -4,7 +4,7 @@ In-app HTTP request lab for Rails. Mounts a UI at `/rails/http-lab` and persists
 
 No external app, no separate workspace — your requests live next to the code that serves them, version-controlled in `docs/http-lab/`.
 
-![Rails HTTP Lab](https://raw.githubusercontent.com/jacksonpires/rails-http-lab/main/docs/rails-http-lab.png)
+![Rails HTTP Lab demo: browsing a collection, sending requests with an environment, editing params, JSON body with bearer auth, cURL export and environments](https://raw.githubusercontent.com/jacksonpires/rails-http-lab/main/docs/rails-http-lab.gif)
 
 ## Why
 
@@ -30,6 +30,21 @@ bin/rails g rails_http_lab:install
 
 Visit `http://localhost:3000/rails/http-lab`.
 
+## Compatibility
+
+Requires Ruby `>= 3.1` and Rails `>= 7.0`. Every combination below runs in
+[CI](.github/workflows/ci.yml):
+
+| Ruby \ Rails | 7.0 | 7.1 | 7.2 | 8.0 | 8.1 |
+|--------------|:---:|:---:|:---:|:---:|:---:|
+| **4.0**      | ✅  | ✅  | ✅  | ✅  | ✅  |
+| **3.4**      | ✅  | ✅  | ✅  | ✅  | ✅  |
+| **3.3**      | ✅  | ✅  | ✅  | ✅  | ✅  |
+| **3.2**      | ✅  | ✅  | ✅  | ✅  | ✅  |
+| **3.1**      | ✅  | ✅  | ✅  | —   | —   |
+
+— Rails 8.x itself requires Ruby `>= 3.2`.
+
 ## Configuration
 
 `config/initializers/rails_http_lab.rb`:
@@ -55,6 +70,20 @@ risk if exposed to untrusted users. Defaults:
 - Bruno `script` and `tests` blocks are **persisted but not executed** to avoid
   arbitrary code execution. Run them in Bruno itself.
 
+## Development
+
+```bash
+bundle install
+bundle exec rspec
+```
+
+To run the suite against a specific Rails series (as CI does), set
+`RAILS_VERSION` before installing:
+
+```bash
+RAILS_VERSION=7.2 bundle update rails && RAILS_VERSION=7.2 bundle exec rspec
+```
+
 ## License
 
 MIT

data/app/assets/javascripts/rails_http_lab/application.js

@@ -86,13 +86,25 @@
   function normalizedSource(doc) {
     if (!doc) return "";
     const blocks = (doc.blocks || []).filter((b) => {
-      if (b.mode === "raw") return (b.raw || "").trim() !== "";
+      if (b.mode === "raw" || b.mode === "list") return (b.raw || "").trim() !== "";
       const pairs = (b.pairs || []).filter(([k, v]) =>
         (k || "").trim() !== "" || (v || "").trim() !== "");
       return pairs.length > 0;
     });
     return serializeDoc({ blocks });
   }
+  // Viewing a tab lazily injects an empty block (e.g. `params:query {}`).
+  // Drop those before writing/sending so they don't pollute the .bru file —
+  // but keep empty blocks that were already on disk, for byte-stable round-trip.
+  function isEmptyBlock(b) {
+    if (b.mode === "raw" || b.mode === "list") return (b.raw || "").trim() === "";
+    return !(b.pairs || []).some(([k, v]) => (k || "").trim() !== "" || (v || "").trim() !== "");
+  }
+  function persistableDoc(session) {
+    const onDisk = new Set((session.savedDoc?.blocks || []).map((b) => b.name));
+    return { blocks: (session.doc.blocks || []).filter((b) => !isEmptyBlock(b) || onDisk.has(b.name)) };
+  }
+
   function isDirty(session) {
     if (!session) return false;
     return normalizedSource(session.doc) !== normalizedSource(session.savedDoc);
@@ -201,10 +213,11 @@
   // ---------- .bru source serializer (client-side) ----------
   function serializeDoc(doc) {
     return (doc.blocks || []).map((b) => {
-      if (b.mode === "raw") {
+      if (b.mode === "raw" || b.mode === "list") {
+        const [open, close] = b.mode === "list" ? ["[", "]"] : ["{", "}"];
         const body = b.raw || "";
         const tail = body.endsWith("\n") || body === "" ? "" : "\n";
-        return `${b.name} {\n${body}${tail}}\n`;
+        return `${b.name} ${open}\n${body}${tail}${close}\n`;
       }
       const lines = (b.pairs || []).map(([k, v]) => `  ${k}: ${v}`).join("\n");
       return `${b.name} {\n${lines}${lines ? "\n" : ""}}\n`;
@@ -300,6 +313,7 @@
     const s = state.sessions.get(hydratedKey);
     if (!s) return;
     state.currentKey = hydratedKey;
+    ensureExpanded(parentDir(hydratedKey));  // don't restore into a collapsed folder
     showEditorForSession(s);
   }
 
@@ -678,6 +692,7 @@
 
   function renderKvTab(panel, blockName, placeholder) {
     const block = ensureKvBlock(blockName);
+    const changed = blockName === "params:query" ? syncUrlFromParams : () => {};
     const table = ce("table", { class: "rhl-kv-table" });
     const thead = ce("thead", {}, ce("tr", {}, ce("th", {}, "Name"), ce("th", {}, "Value"), ce("th", {})));
     const tbody = ce("tbody");
@@ -688,15 +703,15 @@
       const tr = ce("tr");
       tr.appendChild(ce("td", {}, ce("input", {
         value: pair[0] || "", placeholder,
-        oninput: (e) => { block.pairs[i][0] = e.target.value; }
+        oninput: (e) => { block.pairs[i][0] = e.target.value; changed(); }
       })));
       tr.appendChild(ce("td", {}, ce("input", {
         value: pair[1] || "", placeholder: "value",
-        oninput: (e) => { block.pairs[i][1] = e.target.value; }
+        oninput: (e) => { block.pairs[i][1] = e.target.value; changed(); }
       })));
       tr.appendChild(ce("td", { class: "rhl-kv-table__del" }, ce("button", {
         class: "rhl-iconbtn",
-        onclick: () => { block.pairs.splice(i, 1); onDocEdited(); renderPanel(); }
+        onclick: () => { block.pairs.splice(i, 1); changed(); onDocEdited(); renderPanel(); }
       }, "×")));
       tbody.appendChild(tr);
     });
@@ -826,6 +841,40 @@
     }
   }
 
+  // ---------- URL <-> params:query sync ----------
+  // Bruno keeps the URL's query string and the params:query block mirrored
+  // (and only sends the URL), so edits on either side must update the other.
+  // Disabled params (`~key`) live only in the block, never in the URL.
+  function splitUrl(url) {
+    const i = url.indexOf("?");
+    return i < 0 ? [url, ""] : [url.slice(0, i), url.slice(i + 1)];
+  }
+  function syncUrlFromParams() {
+    if (!currentDoc()) return;
+    const block = findBlock(currentDoc(), "params:query");
+    const enabled = (block?.pairs || []).filter(([k]) => k && !k.startsWith("~"));
+    const [base] = splitUrl($("#rhl-url").value);
+    const qs = enabled.map(([k, v]) => `${k}=${v || ""}`).join("&");
+    const url = qs ? `${base}?${qs}` : base;
+    $("#rhl-url").value = url;
+    setVerbPair("url", url);
+  }
+  function syncParamsFromUrl() {
+    const doc = currentDoc();
+    if (!doc) return;
+    const [, qs] = splitUrl($("#rhl-url").value);
+    const fromUrl = qs.split("&").filter(Boolean).map((part) => {
+      const i = part.indexOf("=");
+      return i < 0 ? [part, ""] : [part.slice(0, i), part.slice(i + 1)];
+    });
+    const existing = findBlock(doc, "params:query");
+    if (!existing && fromUrl.length === 0) return;
+    const block = existing || ensureKvBlock("params:query");
+    const disabled = block.pairs.filter(([k]) => (k || "").startsWith("~"));
+    block.pairs = [...fromUrl, ...disabled];
+    if (activeSession()?.activeTab === "params") renderPanel();
+  }
+
   function formRow(label, block, field) {
     const pair = block.pairs.find(([k]) => k === field);
     const input = ce("input", {
@@ -885,7 +934,7 @@
     state.envName = envName;
     try {
       const resp = await api("POST", "/run", {
-        source: serializeDoc(session.doc),
+        source: serializeDoc(persistableDoc(session)),
         environment: envName
       });
       session.response = resp;
@@ -910,14 +959,14 @@
       if (!path.endsWith(".bru")) path += ".bru";
     }
     try {
-      await api("PUT", `/requests/${encodePath(path)}`, { source: serializeDoc(session.doc) });
+      await api("PUT", `/requests/${encodePath(path)}`, { source: serializeDoc(persistableDoc(session)) });
       if (path !== session.path) {
         state.sessions.delete(session.path);
         session.path = path;
         state.sessions.set(path, session);
         state.currentKey = path;
       }
-      session.savedDoc = cloneDoc(session.doc);  // now clean
+      session.savedDoc = cloneDoc(persistableDoc(session));  // now clean (matches disk)
       session._wasDirty = false;
       ensureExpanded(parentDir(path));
       await loadTree();
@@ -1300,7 +1349,11 @@
 
     // Keep verb/url synced into the active doc as the user types.
     $("#rhl-verb").addEventListener("change", () => { if (currentDoc()) setVerbName($("#rhl-verb").value.toLowerCase()); });
-    $("#rhl-url").addEventListener("input",   () => { if (currentDoc()) setVerbPair("url", $("#rhl-url").value); });
+    $("#rhl-url").addEventListener("input",   () => {
+      if (!currentDoc()) return;
+      setVerbPair("url", $("#rhl-url").value);
+      syncParamsFromUrl();
+    });
   }
 
   document.addEventListener("DOMContentLoaded", async () => {

data/app/assets/stylesheets/rails_http_lab/application.css

@@ -253,6 +253,7 @@ html, body.rhl-body {
 
 .rhl-response__meta { display: flex; gap: 8px; font-size: 12px; align-items: center; }
 .rhl-response__meta span { padding: 2px 8px; background: var(--rhl-bg-alt); border-radius: 3px; font-family: -apple-system, BlinkMacSystemFont, sans-serif; }
+.rhl-response__meta span:empty { display: none; }
 .rhl-pill { font-weight: 700; }
 .rhl-pill--ok   { background: #DCEEDC !important; color: var(--rhl-success); }
 .rhl-pill--warn { background: #FFE9C7 !important; color: var(--rhl-warn); }

data/app/controllers/rails_http_lab/application_controller.rb

@@ -39,8 +39,8 @@ module RailsHttpLab
 
     def render_unprocessable(error)
       respond_to do |format|
-        format.json { render json: { error: error.message }, status: :unprocessable_entity }
-        format.any  { head :unprocessable_entity }
+        format.json { render json: { error: error.message }, status: 422 }
+        format.any  { head 422 }
       end
     end
   end

data/app/controllers/rails_http_lab/environments_controller.rb

@@ -17,15 +17,29 @@ module RailsHttpLab
         v = v.to_unsafe_h if v.respond_to?(:to_unsafe_h)
         [v["key"].to_s, v["value"].to_s]
       }
-      doc = RailsHttpLab::Bruno::Document.new(blocks: [
-        RailsHttpLab::Bruno::Block.new(name: "vars", mode: :kv, pairs: pairs)
-      ])
-      storage.write_bru("environments/#{params[:name]}.bru", doc)
+      rel = "environments/#{params[:name]}.bru"
+      doc = existing_document(rel) || RailsHttpLab::Bruno::Document.new
+      vars_block = doc.block("vars")
+      if vars_block
+        vars_block.pairs = pairs
+      else
+        # Bruno writes `vars` first, before e.g. `vars:secret [ ... ]`.
+        doc.blocks.unshift(RailsHttpLab::Bruno::Block.new(name: "vars", mode: :kv, pairs: pairs))
+      end
+      # Only `vars` is editable here; any other block (notably the
+      # `vars:secret` list Bruno desktop maintains) is written back untouched.
+      storage.write_bru(rel, doc)
       render json: { ok: true }
     end
 
     private
 
+    def existing_document(rel)
+      storage.read_bru(rel)
+    rescue RailsHttpLab::NotFoundError
+      nil
+    end
+
     def storage
       @storage ||= RailsHttpLab::Storage::Filesystem.new
     end

data/app/controllers/rails_http_lab/requests_controller.rb

@@ -73,6 +73,8 @@ module RailsHttpLab
         mode = b["mode"]&.to_sym || :kv
         if mode == :raw
           docs << "#{b['name']} {\n#{b['raw']}\n}\n"
+        elsif mode == :list
+          docs << "#{b['name']} [\n#{b['raw']}\n]\n"
         else
           lines = Array(b["pairs"]).map { |k, v| "  #{k}: #{v}" }.join("\n")
           docs << "#{b['name']} {\n#{lines}#{lines.empty? ? '' : "\n"}}\n"
@@ -89,6 +91,8 @@ module RailsHttpLab
         blocks: doc.blocks.map { |b|
           if b.kv?
             { name: b.name, mode: "kv", pairs: b.pairs }
+          elsif b.list?
+            { name: b.name, mode: "list", raw: b.raw }
           else
             { name: b.name, mode: "raw", raw: b.raw }
           end

data/lib/rails_http_lab/bruno/block.rb

@@ -1,7 +1,11 @@
 module RailsHttpLab
   module Bruno
     class Block
-      MODES = %i[kv raw].freeze
+      # :kv   — `name {` + `key: value` lines
+      # :raw  — `name {` + opaque body, verbatim
+      # :list — `name [` + one item per line (e.g. Bruno's `vars:secret [`),
+      #         body kept verbatim in `raw` for byte-stable round-trip
+      MODES = %i[kv raw list].freeze
 
       attr_accessor :name, :mode, :pairs, :raw
 
@@ -15,6 +19,13 @@ module RailsHttpLab
 
       def kv?;  mode == :kv;  end
       def raw?; mode == :raw; end
+      def list?; mode == :list; end
+
+      # Item names of a :list block. Bruno separates items with ",\n".
+      def items
+        return [] unless list?
+        raw.to_s.split("\n").map { |l| l.strip.delete_suffix(",").strip }.reject(&:empty?)
+      end
 
       def [](key)
         return nil unless kv?
@@ -35,6 +46,8 @@ module RailsHttpLab
       def to_h
         if kv?
           pairs.to_h
+        elsif list?
+          { items: items }
         else
           { raw: raw }
         end

data/lib/rails_http_lab/bruno/parser.rb

@@ -5,9 +5,10 @@ module RailsHttpLab
   module Bruno
     # Parses Bruno .bru files into a Document of ordered Blocks.
     #
-    # Two content modes:
-    #   - :kv  — every line is "  key: value" (2-space indent), one pair per line.
-    #   - :raw — opaque body, preserved verbatim. Used for body:json, body:text,
+    # Three content modes:
+    #   - :kv   — every line is "  key: value" (2-space indent), one pair per line.
+    #   - :list — `name [ ... ]` (e.g. `vars:secret`), body preserved verbatim.
+    #   - :raw  — opaque body, preserved verbatim. Used for body:json, body:text,
     #            body:xml, body:graphql, body:graphql:vars, body:sparql,
     #            script:pre-request, script:post-response, tests, docs.
     #
@@ -29,6 +30,8 @@ module RailsHttpLab
 
       # name = letters/digits/_/- with optional colon-delimited variants
       BLOCK_OPEN_RE = /\A([a-zA-Z][\w-]*(?::[\w-]+)*)\s*\{\s*\z/
+      # List blocks, e.g. the `vars:secret [ ... ]` Bruno writes in environments.
+      LIST_OPEN_RE  = /\A([a-zA-Z][\w-]*(?::[\w-]+)*)\s*\[\s*\z/
 
       def self.parse(source)
         new(source).parse
@@ -67,6 +70,9 @@ module RailsHttpLab
             else
               blocks << parse_kv_block(name)
             end
+          elsif (m = line.match(LIST_OPEN_RE))
+            @i += 1
+            blocks << parse_list_block(m[1])
           else
             # If we got here we hit something we don't understand. To stay forgiving,
             # skip it; alternatively raise. We raise so callers know their file is off.
@@ -159,6 +165,20 @@ module RailsHttpLab
         in_triple || depth > 0
       end
 
+      # Reads until a line that is exactly "]" (Bruno's convention). Item lines
+      # are kept verbatim so the block round-trips byte-for-byte.
+      def parse_list_block(name)
+        content_lines = []
+        while @i < @lines.length
+          line = @lines[@i]
+          @i += 1
+          return Block.new(name: name, mode: :list, raw: content_lines.join("\n")) if line.strip == "]"
+          content_lines << line
+        end
+
+        raise ParseError, "unterminated list block #{name.inspect} (missing closing ']')"
+      end
+
       # Counts braces to find matching '}'. Body content can include arbitrary braces
       # (JSON objects, JS blocks, etc.) so we can't rely on indentation alone.
       def parse_raw_block(name)

data/lib/rails_http_lab/bruno/serializer.rb

@@ -42,7 +42,8 @@ module RailsHttpLab
       def render_block(block)
         case block.mode
         when :kv  then render_kv(block)
-        when :raw then render_raw(block)
+        when :raw  then render_raw(block)
+        when :list then render_raw(block, open: "[", close: "]")
         end
       end
 
@@ -55,12 +56,12 @@ module RailsHttpLab
         lines
       end
 
-      def render_raw(block)
+      def render_raw(block, open: "{", close: "}")
         body = block.raw.to_s
-        out = +"#{block.name} {\n"
+        out = +"#{block.name} #{open}\n"
         out << body
         out << "\n" unless body.empty? || body.end_with?("\n")
-        out << "}\n"
+        out << "#{close}\n"
         out
       end
     end

data/lib/rails_http_lab/execution/runner.rb

@@ -43,8 +43,15 @@ module RailsHttpLab
         body_kind = verb_block["body"].to_s
         auth_kind = verb_block["auth"].to_s
 
+        unresolved = url.scan(/\{\{\s*([^{}]+?)\s*\}\}/).flatten.uniq
+        unless unresolved.empty?
+          names = unresolved.map { |n| "{{#{n}}}" }.join(", ")
+          raise URI::InvalidURIError,
+                "unresolved variable #{names} — select an environment that defines it"
+        end
+
         uri = URI.parse(url)
-        merge_query!(uri)
+        merge_query!(uri, auth_kind)
 
         klass = VERBS.fetch(verb_block.name)
         request = klass.new(uri.request_uri)
@@ -103,16 +110,42 @@ module RailsHttpLab
         Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
 
-      def merge_query!(uri)
+      # Bruno keeps the URL's query string and the `params:query` block in
+      # sync, so the same params usually appear in both. Keys present in the
+      # block (or added by apikey auth) replace the URL's occurrences of those
+      # keys instead of being appended twice; other URL params are kept as-is.
+      def merge_query!(uri, auth_kind)
+        extra = []
+
         params_block = @doc.block("params:query") || @doc.block("query")
-        return unless params_block&.kv?
+        if params_block&.kv?
+          params_block.pairs.each do |k, v|
+            next if k.start_with?("~")
+            extra << [k, @resolver.resolve(v.to_s)]
+          end
+        end
+
+        if auth_kind == "apikey" && (auth = @doc.block("auth:apikey")) && auth["placement"].to_s == "queryparams"
+          key = @resolver.resolve(auth["key"].to_s)
+          extra << [key, @resolver.resolve(auth["value"].to_s)] unless key.empty?
+        end
+
+        return if extra.empty?
 
-        existing = uri.query.to_s
-        extra    = params_block.pairs.reject { |k, _| k.start_with?("~") }.map do |k, v|
-          "#{URI.encode_www_form_component(k)}=#{URI.encode_www_form_component(@resolver.resolve(v.to_s))}"
+        overridden = extra.map(&:first)
+        kept = uri.query.to_s.split("&").reject do |part|
+          part.empty? || overridden.include?(query_key(part))
+        end
+        added = extra.map do |k, v|
+          "#{URI.encode_www_form_component(k)}=#{URI.encode_www_form_component(v)}"
         end
-        merged = [existing, extra.join("&")].reject(&:empty?).join("&")
-        uri.query = merged unless merged.empty?
+        uri.query = (kept + added).join("&")
+      end
+
+      def query_key(part)
+        URI.decode_www_form_component(part.split("=", 2).first)
+      rescue ArgumentError
+        part.split("=", 2).first
       end
 
       def apply_headers!(request)
@@ -138,13 +171,8 @@ module RailsHttpLab
           return unless block
           key = @resolver.resolve(block["key"].to_s)
           val = @resolver.resolve(block["value"].to_s)
-          placement = block["placement"].to_s
-          if placement == "queryparams"
-            uri = request.uri || URI.parse("")
-            # placement in query is handled at URL level; skip here
-          else
-            request[key] = val unless key.empty?
-          end
+          # placement "queryparams" is applied to the URL in merge_query!
+          request[key] = val unless key.empty? || block["placement"].to_s == "queryparams"
         end
       end
 

data/lib/rails_http_lab/version.rb

@@ -1,3 +1,3 @@
 module RailsHttpLab
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-http-lab
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jackson Pires