yobi-http 0.10.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56563ef37ac915d9ea34678799ac53ae2f8d91355dfd383e47929ea17e0814b0
-  data.tar.gz: cc47d7c2010c5177685cd75462e4c2c387befa2d31d117acaf5e99f23dc91e59
+  metadata.gz: fb20dc471298499f2ba3baa43cd51e83039cf67935544fe1f0299de33e709b4c
+  data.tar.gz: 9df3715695a95f5c23b506f1568b4bc42d3ecbe1e031bc6aab6e20d69b482a5d
 SHA512:
-  metadata.gz: 90392c2e87b514c76c3f5b1eaa1049140f38ae2b0c87937379f2f767ba6fff1809b2143433479e99f18a5cb550165aa3003860b173247ddac08ab124a448423e
-  data.tar.gz: 63f13abd60c7e4580d504e2e5cf6b39fa919708309e21dc2371bc78750a7b7f52d9635c2a07561cb043fb5181b66975dde63d3a793e5e29563ab1d2fb8559aa8
+  metadata.gz: b7761b5b83c95b4f8dafcadb20e9c7ab7463fc93f2c4d9334e2de37516ac5990ba5915deffc1dbce0a12f7ceb390d4a4b62b796590b3c966975dbe382ccefb8c
+  data.tar.gz: 342112ecb2fe37dbe4ce278353850207db149eef0cf1bfd088f4d1d646a563771756b481b3eaa76d83a081d3f2e9bea0ebb0457654d95543a2c9c9f0ac024c35

data/Examples.md

@@ -0,0 +1,72 @@
+
+# Yobi HTTP - Usage examples
+
+Some examples of using the 
+
+Some examples of using the Yobi HTTP CLI.
+
+## Simple HTTP Get request
+
+```bash
+yobi --debug https://httpbin.org/get
+```
+
+## HTTP POST request with JSON body
+
+```bash
+yobi --debug POST https://httpbin.org/post name=Yobi type="HTTP client"
+```
+
+## WIP: HTTP POST request with form data
+
+```bash
+yobi --debug POST https://httpbin.org/post name=Yobi type="HTTP client" --form
+```
+
+## HTTP request with query parameters
+
+```bash
+yobi --debug https://httpbin.org/get name=Yobi type="HTTP client"
+```
+## HTTP request with basic authentication
+
+```bash
+yobi --debug https://httpbin.org/basic-auth/user/passwd --auth user:passwd --auth-type basic
+```
+
+## HTTP request with timeout
+
+```bash
+yobi --debug --timeout 5 https://httpbin.org/delay/10
+```
+
+## HTTP request with custom headers
+
+```bash
+yobi --debug https://httpbin.org/headers X-Custom-Header:Yobi User-Agent:"Yobi HTTP Client"
+```
+
+## Download a file
+
+```bash
+yobi --debug --download https://ash-speed.hetzner.com/100MB.bin -o sample.bin
+```
+
+## HTTP request with follow redirects
+
+```bash
+yobi --debug --follow https://httpbin.org/redirect/3
+```
+
+## HTTP request with output to a file
+
+```bash
+yobi -p B https://httpbin.org/get -o response.json
+```
+
+## HTTP request with verbose output
+
+```bash
+yobi --debug --verbose https://httpbin.org/get
+```
+

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Daniel Vinciguerra
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/exe/yobi

@@ -15,7 +15,8 @@ require "yobi"
 
 # parsing arguments
 @options = {
-  print: "HB", auth: nil, auth_type: "basic", verbose: false, raw: false, offline: false, follow: false, debug: false
+  print: "HB", auth: nil, auth_type: "basic", verbose: false, raw: false, offline: false, follow: false, debug: false,
+  timeout: nil, download: false
 }
 
 parser = OptionParser.new do |opts|
@@ -36,8 +37,8 @@ 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.upcase || "HB" # default to printing both headers and body
-    warn "[Argument Error] Unsupported format: #{format}" unless format.match?(/\A[HB]+\z/i)
+    @options[:print] = format || "HB" # default to printing both headers and body
+    warn "[Argument Error] Unsupported format: #{format}" unless format.match?(/\A[HBhb]+\z/)
   end
 
   opts.on("-a", "--auth USER:PASS", "Specify basic authentication credentials") do |auth|
@@ -69,9 +70,16 @@ parser = OptionParser.new do |opts|
     @options[:output] = file
   end
 
+  opts.on("--timeout SECONDS", "Set a custom timeout for the request (integer or float)") do |timeout|
+    @options[:timeout] = timeout.to_f
+  end
+
+  opts.on("--download", "Download response body to a file specified by --output") do
+    @options[:download] = true
+  end
+
   opts.on("-v", "--verbose", "Print detailed request and response information") do
     @options[:verbose] = true
-
   end
 
   opts.on("--debug", "Print debug information") do
@@ -99,81 +107,25 @@ headers = Yobi.args.parse_headers(ARGV)
 # prepare authentication header if auth is provided
 Yobi.args.auth_header(headers, @options) if @options[:auth]
 
-pp [method, url, data, headers, @options, ARGV] if ENV["YOBI_DEBUG"]
-
-# Extend Net::HTTPResponse to add util behaviors
-def offline_mode(request, options)
-  Net::HTTP.class_eval do
-    def connect; end
-  end
-
-  options[:verbose] = true
-
-  response = Net::HTTPResponse.new("1.1", "200", "OK")
-  response["Content-Type"] = "application/json"
-  response["Access-Control-Allow-Credentials"] = true
-  response["Access-Control-Allow-Origin"] = "*"
-  response["Connection"] = "close"
-  response["Date"] = Time.now.httpdate
-  response["Server"] = "yobi-offline/#{Yobi::VERSION}"
-  response["X-Powered-By"] = "Yobi/#{Yobi::VERSION}"
-  response.body = body = JSON.pretty_generate({ message: "Offline mode enabled" })
-
-  view = Yobi.view(:output)
-  puts TTY::Markdown.parse(view.result(binding), color: :always)
-
-  exit 0
-end
-
-def raw_mode(_request, response, options)
-  if options[:print].include?("H")
-    puts "HTTP/#{response.http_version} #{response.code} #{response.message}"
-    response.each_header { |key, value| puts "#{key}: #{value}" }
-    puts
-  end
-
-  body = response.parsed_body
-  puts body if options[:print].include?("B") && body
-
-  exit 0
-end
-
-def follow_redirects(response, url, method, data, headers, options)
-  return response unless response.is_a?(Net::HTTPRedirection)
-
-  location = response["location"]
-  warn "Redirected to #{location}" if options[:debug]
-  new_url = URI.join(url, location).to_s
-
-  Yobi.request(method, new_url, data: data, headers: headers, options: options) do |new_http, new_request|
-    response = new_http.request(new_request)
-    return follow_redirects(response, new_url, method, data, headers, options)
-  end
-end
-
-Yobi.request(method, url, data: data, headers: headers, options: @options) do |http, request|
+Yobi::Http.request(method, url, data: data, headers: headers, options: @options) do |http, request|
   options = @options
 
-  offline_mode(request, options) if options[:offline]
-
+  # follow redirects, offline, download or standard request mode
   response =
     if options[:follow]
-      follow_redirects(http.request(request), url, method, data, headers, options)
+      Yobi::Http.follow_redirects(http.request(request), url, method, data, headers, options)
+    elsif options[:offline]
+      Yobi::Http.offline_mode(request, options)
+    elsif options[:download]
+      Yobi::Http.download(request, http, options)
     else
       http.request(request)
     end
 
-  raw_mode(request, response, options) if options[:raw]
-
-  body = JSON.pretty_generate(response.parsed_body)
-
-  view = Yobi.view(:output)
-  output_result = view.result(binding)
-
-  if options[:output]
-    file = File.expand_path(options[:output], Dir.pwd)
-    File.write(file, output_result, mode: "w")
+  # render output
+  if options[:raw]
+    Yobi::Renders::Raw.render(request, response, options)
   else
-    puts TTY::Markdown.parse(output_result, color: :always)
+    Yobi::Renders::Colored.render(request, response, options)
   end
 end

data/lib/yobi/http.rb

@@ -8,7 +8,7 @@ module Yobi
     METHODS = %w[GET POST PUT DELETE PATCH HEAD OPTIONS].freeze
 
     class << self
-      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def request(method, url, data: {}, headers: {}, options: {})
         @uri = URI(url)
         @options = options
@@ -18,14 +18,82 @@ module Yobi
           request_class = Net::HTTP.const_get(@method)
           request = request_class.new(@uri)
 
+          if @options[:timeout]
+            http.open_timeout = @options[:timeout]
+            http.read_timeout = @options[:timeout]
+          end
+
           headers.each { |key, value| request[key] = value }
 
           request.body = data.to_json unless data.empty?
 
           yield(http, request) if block_given?
+        rescue Net::OpenTimeout, Net::ReadTimeout => e
+          warn "Request timed out: #{e.message}"
+          exit 1
+        end
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+      # rubocop:disable Metrics/ParameterLists
+      def follow_redirects(response, url, method, data, headers, options)
+        return response unless response.is_a?(Net::HTTPRedirection)
+
+        location = response["location"]
+        warn "Redirected to #{location}" if options[:debug]
+        new_url = URI.join(url, location).to_s
+
+        request(method, new_url, data: data, headers: headers, options: options) do |new_http, new_request|
+          response = new_http.request(new_request)
+          return follow_redirects(response, new_url, method, data, headers, options)
         end
       end
-      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/ParameterLists
+
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def offline_mode(_request, options)
+        Net::HTTP.class_eval do
+          def connect; end
+        end
+
+        options[:verbose] = true
+
+        Net::HTTPResponse.new("1.1", "200", "OK").tap do |response|
+          response["Content-Type"] = "application/json"
+          response["Access-Control-Allow-Credentials"] = true
+          response["Access-Control-Allow-Origin"] = "*"
+          response["Connection"] = "close"
+          response["Date"] = Time.now.httpdate
+          response["Server"] = "yobi-offline/#{Yobi::VERSION}"
+          response["X-Powered-By"] = "Yobi/#{Yobi::VERSION}"
+
+          response.body = JSON.pretty_generate({ message: "Offline mode enabled" })
+          response.instance_variable_set(:@read, true)
+        end
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def download(request, http, options)
+        http.request(request) do |response|
+          url = request.uri.to_s
+          total_bytes = response["Content-Length"]&.to_i
+          progress = Yobi::UI::Progress.new(total_bytes)
+
+          filename = options[:output] || File.basename(URI.parse(url).path)
+          File.open(filename, "wb") do |file|
+            response.read_body do |chunk|
+              file.write(chunk)
+              progress.increment(chunk.size)
+            end
+          end
+
+          puts "\nDownload finished: #{filename}"
+        end
+
+        exit 0
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
     end
   end
 end

data/lib/yobi/renders/colored.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Yobi
+  module Renders
+    # Render a colored output of the request and response
+    module Colored
+      class << self
+        def compile(request, response, options = {})
+          body =
+            JSON.pretty_generate(response.parsed_body) rescue response.body # rubocop:disable Style/RescueModifier
+
+          view = Yobi.view(:output)
+          TTY::Markdown.parse(view.result(binding), color: :always)
+        end
+
+        def render(request, response, options = {})
+          view = compile(request, response, options)
+
+          if options[:output]
+            file_path = ::File.expand_path(options[:output], Dir.pwd)
+            ::File.write(file_path, view, mode: "wb")
+          else
+            puts view
+          end
+
+          exit 0
+        end
+      end
+    end
+  end
+end

data/lib/yobi/renders/raw.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Yobi
+  module Renders
+    # Render a raw output of the request and response
+    module Raw
+      class << self
+        def compile(request, response, options = {})
+          arguments request: request, response: response, options: options
+
+          buffer.tap do
+            compile_request
+            compile_response
+          end
+        end
+
+        def render(request, response, options = {})
+          view = compile(request, response, options)
+
+          if options[:output]
+            file_path = ::File.expand_path(options[:output], Dir.pwd)
+            ::File.write(file_path, view, mode: "wb")
+          else
+            puts view
+          end
+
+          exit 0
+        end
+
+        private
+
+        attr_reader :request, :response, :options
+
+        def buffer
+          @buffer ||= String.new
+        end
+
+        def arguments(**args)
+          @request = args[:request]
+          @response = args[:response]
+          @options = args[:options] || {}
+        end
+
+        def show_header?(request_or_response)
+          options[:print].include?(request_or_response.is_a?(Net::HTTPResponse) ? "H" : "h")
+        end
+
+        def show_body?(request_or_response)
+          options[:print].include?(request_or_response.is_a?(Net::HTTPResponse) ? "B" : "b")
+        end
+
+        def compile_request
+          compile_request_header
+          compile_request_body
+
+          buffer << "\n" * 2 if show_header?(request) || show_body?(request)
+        end
+
+        def compile_request_header
+          return unless show_header? request
+
+          buffer << "#{request.method} #{request.path} HTTP/1.1 \n"
+          request.each_capitalized.sort.each do |key, value|
+            buffer << "#{key}: #{value}\n"
+          end
+          buffer << "\n"
+        end
+
+        def compile_request_body
+          return unless show_body?(request) && request.body && !request.body.empty?
+
+          buffer << "#{JSON.pretty_generate(request.parsed_body) rescue request.body}\n" # rubocop:disable Style/RescueModifier
+        end
+
+        def compile_response
+          compile_response_header
+          compile_response_body
+        end
+
+        def compile_response_header
+          return unless show_header? response
+
+          buffer << "HTTP/#{response.http_version} #{response.code} #{response.message}\n"
+          response.each_header { |key, value| buffer << "#{key}: #{value}\n" }
+          buffer << "\n"
+        end
+
+        def compile_response_body
+          return unless response.body && !response.body.empty? && options[:print].include?("B")
+
+          buffer << "#{JSON.pretty_generate(response.parsed_body)}\n"
+        end
+      end
+    end
+  end
+end

data/lib/yobi/renders.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir.glob(File.expand_path("renders/*.rb", __dir__)).sort.each do |path|
+  require path
+end

data/lib/yobi/ui/progress.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Yobi
+  module UI
+    # Simple terminal progress bar
+    class Progress
+      BAR_WIDTH = 40
+
+      STYLE = {
+        arrow: { complete: "▸", incomplete: "▹", unknown: "◂▸" },
+        asterisk: { complete: "✱", incomplete: "✳", unknown: "✳✱✳" },
+        blade: { complete: "▰", incomplete: "▱", unknown: "▱▰▱" },
+        block: { complete: "█", incomplete: "░", unknown: "░█░" },
+        box: { complete: "■", incomplete: "□", unknown: "□■□" },
+        bracket: { complete: "❭", incomplete: " ", unknown: "❬=❭" },
+        burger: { complete: "≡", incomplete: " ", unknown: "<≡>" },
+        button: { complete: "⦿", incomplete: "⦾", unknown: "⦾⦿⦾" },
+        chevron: { complete: "›", incomplete: " ", unknown: "‹=›" },
+        circle: { complete: "●", incomplete: "○", unknown: "○●○" },
+        classic: { complete: "=", incomplete: " ", unknown: "<=>" },
+        crate: { complete: "▣", incomplete: "⬚", unknown: "⬚▣⬚" },
+        diamond: { complete: "♦", incomplete: "♢", unknown: "♢♦♢" },
+        dot: { complete: "･", incomplete: " ", unknown: "･･･" },
+        heart: { complete: "♥", incomplete: "♡", unknown: "♡♥♡" },
+        star: { complete: "★", incomplete: "☆", unknown: "☆★☆" }
+      }.freeze
+
+      def initialize(total_bytes = nil, options = { style: :block })
+        @total = total_bytes
+        @downloaded = 0
+        @last_draw = Time.now
+        @options = options
+      end
+
+      def increment(bytes)
+        @downloaded += bytes
+        current_time = Time.now
+
+        return unless current_time - @last_draw >= 0.1 || finished?
+
+        draw
+        @last_draw = current_time
+      end
+
+      def finished?
+        @total && @downloaded >= @total
+      end
+
+      def draw
+        if @total
+          percent = @downloaded.to_f / @total
+          filled  = (percent * BAR_WIDTH).round
+          bar = theme[:complete] * filled + theme[:incomplete] * (BAR_WIDTH - filled)
+          print "\r[#{bar}] #{(percent * 100).round(1)}% "\
+                "(#{human(@downloaded)}/#{human(@total)})"
+        else
+          print "\r#{human(@downloaded)} downloaded"
+        end
+
+        $stdout.flush
+      end
+
+      private
+
+      def theme
+        STYLE[@options[:style]] || STYLE[:box]
+      end
+
+      def human(bytes)
+        if bytes > 1_048_576
+          format("%.2f MiB", bytes / 1_048_576.0)
+        elsif bytes > 1024
+          format("%.2f KiB", bytes / 1024.0)
+        else
+          "#{bytes} B"
+        end
+      end
+    end
+  end
+end

data/lib/yobi/ui.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir.glob(File.expand_path("ui/*.rb", __dir__)).sort.each do |path|
+  require path
+end

data/lib/yobi/version.rb

@@ -2,5 +2,5 @@
 
 module Yobi
   # Yobi gem version
-  VERSION = "0.10.0"
+  VERSION = "0.12.1"
 end

data/lib/yobi.rb

@@ -5,6 +5,8 @@ require "erb"
 require "yobi/cli"
 require "yobi/extensions"
 require "yobi/http"
+require "yobi/ui"
+require "yobi/renders"
 require "yobi/version"
 
 # Yobi Http CLI client namespace

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yobi-http
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Daniel Vinciguerra
 bindir: exe
 cert_chain: []
-date: 2026-02-22 00:00:00.000000000 Z
+date: 2026-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -37,8 +37,18 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-description: Yobi is a simple HTTP client for testing APIs from the command line built
-  with Ruby
+description: |
+  Yobi is a terminal tool to make HTTP requests and display responses in a friendly way inspired by HTTPie.
+
+  It allows you to easily send HTTP requests and view the responses in a human-readable format, making it easier
+  to debug and test APIs from the command line.
+
+  The main features of Yobi include:
+    * Support for various HTTP methods (GET, POST, PUT, DELETE, etc.)
+    * Customizable request headers and body
+    * Pretty-printed responses with syntax highlighting
+    * Download response content to a file
+    * Low dependency and easy installation
 email:
 - daniel.vinciguerra@bivee.com.br
 executables:
@@ -50,6 +60,8 @@ files:
 - Agents.md
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Examples.md
+- MIT-LICENSE
 - README.md
 - Rakefile
 - exe/yobi
@@ -61,6 +73,11 @@ files:
 - lib/yobi/extensions/net_http.rb
 - lib/yobi/extensions/net_http/parsing.rb
 - lib/yobi/http.rb
+- lib/yobi/renders.rb
+- lib/yobi/renders/colored.rb
+- lib/yobi/renders/raw.rb
+- lib/yobi/ui.rb
+- lib/yobi/ui/progress.rb
 - lib/yobi/version.rb
 - screenshot.png
 - spec/extensions/net_http/parsing_spec.rb
@@ -70,7 +87,8 @@ files:
 - spec/yobi/http_spec.rb
 - spec/yobi_spec.rb
 homepage: https://github.com/dvinciguerra/yobi-http
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/dvinciguerra/yobi-http
   source_code_uri: https://github.com/dvinciguerra/yobi-http
@@ -91,6 +109,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: Yobi is a simple HTTP client for testing APIs from the command line built
-  with Ruby
+summary: Yobi is a terminal tool to make HTTP requests and display responses in a
+  friendly way inspired by HTTPie.
 test_files: []