yobi-http 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5994458b4f28cc4879858782a1dbc26a90f8ab77d7bf97b5a13ee7aaec13092
-  data.tar.gz: ac095c048327a1ce8260f388dcc414c647fa9f912f15ab9f43fabb1327225f69
+  metadata.gz: ee3f871068b818f6f194f64edecbfe16bfb51c5d590445da566a8e6229bd3b28
+  data.tar.gz: 17e8538a544d0cdc95317180a7e11418460c26288ee5f77f770c52356c654c90
 SHA512:
-  metadata.gz: 9a1db1c25476849b0169d3d535d3ced35f2d14034363617211aff38f7903970d9056269231d83e8617392c66587eae32ef42fd573080bd3f5165d8b7de63f63f
-  data.tar.gz: 2ba909e076ccf9a12ff9f624ebe545675d6c540aaa248951a0ff7a5504a38d476c38b07e1fe321e5de921fd693a01be84dcee6169f6a23cde0ce7e01c3020c95
+  metadata.gz: 70b8027ba0bec021821bd8e50bcc216796e29650d3a4791082146b608293e5b7b088ac7352317c0a010f05e8438b92343c3b8e64e1450027888c4d86d9545f63
+  data.tar.gz: 1b5249c74c29c93de6ae4d6138281745b98eedb50d216e52b096248a331ff7ce552b7d53aae0e4da4d045339d7b66b92f12ef4c72ede58d1c0623aa2bb5e8e01

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.20.0]
+
+- Add support to --stream flag
+
 ## [0.6.0]
 
 - Add output to file feature

data/exe/yobi

@@ -16,7 +16,7 @@ require "yobi"
 # parsing arguments
 @options = {
   print: "HB", auth: nil, auth_type: "basic", verbose: false, raw: false, offline: false, follow: false, debug: false,
-  timeout: nil, download: false, output: nil, content_type: :json
+  timeout: nil, download: false, output: nil, content_type: :json, stream: false
 }
 
 parser = OptionParser.new do |opts|
@@ -38,6 +38,7 @@ parser = OptionParser.new do |opts|
 
   opts.on("-p", "--print FORMAT", "Specify the output format (e.g., 'H' for headers, 'B' for body)") do |format|
     @options[:print] = format || "HB" # default to printing both headers and body
+    @options[:print_set_explicitly] = true
     warn "[Argument Error] Unsupported format: #{format}" unless format.match?(/\A[HBhb]+\z/)
   end
 
@@ -105,6 +106,12 @@ parser = OptionParser.new do |opts|
     @options[:timeout] = timeout.to_f
   end
 
+  opts.on("--stream", "Stream response body (chunked transfer encoding), printing each chunk as it arrives") do
+    @options[:stream] = true
+    # Default to body-only when streaming, unless the user already set --print explicitly
+    @options[:print] = "B" unless @options[:print_set_explicitly]
+  end
+
   opts.on("--download", "Download response body to a file specified by --output") do
     @options[:download] = true
   end
@@ -147,12 +154,14 @@ Yobi.args.auth_header(headers, @options) if @options[:auth]
 Yobi::Http.request(method, url, data: data, headers: headers, query: query, options: @options) do |http, request|
   options = @options
 
-  # follow redirects, offline, download or standard request mode
+  # follow redirects, offline, download, stream or standard request mode
   response =
     if options[:follow]
       Yobi::Http.follow_redirects(http.request(request), url, method, data, headers, options)
     elsif options[:offline]
       Yobi::Http.offline_mode(request, options)
+    elsif options[:stream]
+      Yobi::Http.stream(request, http, options)
     elsif options[:download]
       Yobi::Http.download(request, http, options)
     else

data/lib/yobi/http.rb

@@ -92,6 +92,24 @@ module Yobi
       end
       # rubocop:enable Metrics/AbcSize
 
+      def stream(request, http, options)
+        http.request(request) do |response|
+          Yobi::Renders::Stream.render_headers(response, options)
+
+          response.read_body do |chunk|
+            Yobi::Renders::Stream.render_chunk(chunk, options)
+          end
+
+          Yobi::Renders::Stream.flush_buffer(options)
+        end
+
+        exit 0
+      rescue Interrupt
+        Yobi::Renders::Stream.flush_buffer(options)
+        $stdout.puts
+        exit 0
+      end
+
       # rubocop:disable Metrics/AbcSize
       def download(request, http, options)
         http.request(request) do |response|

data/lib/yobi/renders/stream.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Yobi
+  module Renders
+    # Render streaming (chunked) response chunks to the terminal as they arrive
+    module Stream
+      class << self
+        # Called once when the response headers are received
+        def render_headers(response, options = {})
+          return unless options[:print]&.include?("H")
+
+          if options[:raw]
+            $stdout.puts "HTTP/#{response.http_version} #{response.code} #{response.message}"
+            response.each_header { |key, value| $stdout.puts "#{key}: #{value}" }
+            $stdout.puts
+          else
+            header_md = "# HTTP/#{response.http_version} #{response.code} #{response.message}\n\n" \
+                        "```yaml\n" \
+                        "#{response.each_capitalized.to_h.sort.map { |k, v| "#{k}: #{v}" }.join("\n")}\n" \
+                        "```\n"
+            $stdout.print TTY::Markdown.parse(header_md, color: :always)
+          end
+
+          $stdout.flush
+        end
+
+        # Called for each chunk received. Buffers partial lines across calls so
+        # that JSON objects split across chunk boundaries are handled correctly.
+        def render_chunk(chunk, options = {})
+          return if chunk.nil? || chunk.empty?
+          return unless options[:print]&.include?("B")
+
+          if options[:raw]
+            $stdout.print chunk
+            $stdout.flush
+            return
+          end
+
+          data = (@line_buffer || "") + chunk
+          @line_buffer = nil
+
+          lines = data.split("\n", -1)
+
+          @line_buffer = lines.pop unless data.end_with?("\n")
+
+          lines.each do |line|
+            next if line.empty?
+
+            parsed = begin
+              JSON.parse(line)
+            rescue JSON::ParserError
+              nil
+            end
+
+            if parsed
+              pretty = JSON.pretty_generate(parsed)
+              md = "```json\n#{pretty}\n```\n"
+              $stdout.print TTY::Markdown.parse(md, color: :always)
+            else
+              $stdout.puts line
+            end
+
+            $stdout.flush
+          end
+        end
+
+        # Flush any remaining buffered line when the connection closes
+        def flush_buffer(options = {})
+          return unless @line_buffer && !@line_buffer.empty?
+          return unless options[:print]&.include?("B")
+
+          line = @line_buffer
+          @line_buffer = nil
+
+          parsed = begin
+            JSON.parse(line)
+          rescue JSON::ParserError
+            nil
+          end
+
+          if parsed && !options[:raw]
+            pretty = JSON.pretty_generate(parsed)
+            md = "```json\n#{pretty}\n```\n"
+            $stdout.print TTY::Markdown.parse(md, color: :always)
+          else
+            $stdout.puts line
+          end
+
+          $stdout.flush
+        end
+      end
+    end
+  end
+end

data/lib/yobi/version.rb

@@ -2,5 +2,5 @@
 
 module Yobi
   # Yobi gem version
-  VERSION = "0.18.0"
+  VERSION = "0.20.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yobi-http
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Daniel Vinciguerra
 bindir: exe
 cert_chain: []
-date: 2026-03-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -77,6 +77,7 @@ files:
 - lib/yobi/renders.rb
 - lib/yobi/renders/colored.rb
 - lib/yobi/renders/raw.rb
+- lib/yobi/renders/stream.rb
 - lib/yobi/ui.rb
 - lib/yobi/ui/progress.rb
 - lib/yobi/version.rb
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Yobi is a terminal tool to make HTTP requests and display responses in a
   friendly way inspired by HTTPie.