api-tester-cli 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 155299a42034d93ed03164056d6ca453bcf3e43acc282ddb015a3b14f4e51b7c
+  data.tar.gz: 45e106438c46b807e9493f073f7890779de95f37a8391eb2a390b37c70f6e695
+SHA512:
+  metadata.gz: 915563f0c5af3a185729d25bce93d418e76c2842de9412eb24f1cc62fe89f6cbd7e23259b56a75b10bfff026fe0729c1356bc858f23ec9dc01103a193a21ac5b
+  data.tar.gz: 3dc5c338d28ede087a7077978e17f8321e680361258c38c83cfe6b69824aba42fc80765a9289acd57d923d0f3867dbe446049423fadc0751f4e65561fb33d654

data/README.md

@@ -0,0 +1,74 @@
+
+#  API Tester CLI Tool
+A simple command-line tool to test REST APIs. This tool allows you to interactively input API details or provide them as command-line arguments for quick testing.
+
+##  Features
+
+- Supports HTTP methods (GET, POST, PUT, DELETE)
+- Allows adding custom headers
+- Supports JSON body for requests
+- Bearer token authentication
+- Interactive mode for beginners
+- Command-line mode for advanced users
+- Colored and formatted output for better readability
+
+##  Installation
+
+1. Clone the repository:
+	```bash
+	git clone https://github.com/bhavyansh001/api-tester.git
+	```
+2. Install dependencies:
+	```bash
+	bundle install
+	```
+3. Run the CLI tool:
+	```bash
+	cd api-tester
+	chmod +x bin/api-tester
+	```
+##  Usage
+
+1. Interactive Mode
+Run the tool without any arguments, and it will prompt you for the necessary information interactively.
+	```bash
+	bin/api-tester
+	```
+You will be asked to provide the following:
+- URL
+- HTTP Method (GET, POST, PUT, DELETE)
+- Body (as JSON)
+- Bearer Token (if needed)
+- Custom Headers (optional)
+	
+2. Command-Line Mode
+You can also provide arguments directly to make the process faster.
+	```bash
+	bin/api-tester -u https://your-api.com/login -m POST -H '{"Content-Type": "application/json"}' -b '{"email": "user@example.com", "password": "password123"}' -t  'your_bearer_token'
+	```
+Options:
+- -u, --url : The API URL.
+- -m, --method : The HTTP method (GET, POST, PUT, DELETE).
+- -b, --body : The request body as JSON.
+- -H, --headers : Custom headers as JSON.
+- -t, --token : Bearer token for authorization.
+
+3. Response
+The response from the server is displayed with colored status codes, headers in table format, and pretty-printed JSON body.
+
+## Logging
+
+The tool provides colored logging to enhance visibility. Output includes details about the request, response status, and any errors encountered.
+
+## Best Practices
+
+Respect the API's terms of service and rate limits.
+Ensure you have permission to test authenticated endpoints.
+Use caution with sensitive information when testing.
+
+## Contributing
+
+Contributions are welcome! Report bugs and submit pull requests on GitHub at https://github.com/bhavyansh001/api_tester_cli. Please adhere to the Contributor Covenant code of conduct.
+
+## License
+api_tester_cli is released under the MIT License. See the LICENSE file for details.

data/bin/api-tester

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require 'optparse'
+require 'colorize'
+require_relative '../lib/api_tester'
+
+def send_request(options)
+  # Create and send request using options
+  request = ApiTester::Request.new
+  request.set_method(options[:method])
+  request.set_headers(options[:headers])
+  request.set_body(options[:body]) if options[:body]
+  request.set_auth_token(options[:token]) if options[:token]
+
+  client = ApiTester::Client.new(options[:url], request.headers, request.method, request.body, request.token)
+
+  # Display formatted request info
+  puts "\nSending request to: #{options[:url]}".green
+  puts "Method: #{options[:method]}".green
+  puts "Headers: #{options[:headers]}".green
+  puts "Body: #{options[:body].to_json}" if options[:body]
+
+  # Send the request and display the response
+  response = client.send_request
+  response.display
+end
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: api-tester [options]"
+
+  opts.on("-u", "--url URL", "API URL") { |v| options[:url] = v }
+  opts.on("-m", "--method METHOD", "HTTP method") { |v| options[:method] = v.upcase }
+  opts.on("-b", "--body BODY", "Request body as JSON") { |v| options[:body] = JSON.parse(v) }
+  opts.on("-H", "--headers HEADERS", "Request headers as JSON") { |v| options[:headers] = JSON.parse(v) }
+  opts.on("-t", "--token TOKEN", "Bearer token for authorization") { |v| options[:token] = v }
+end.parse!
+
+# If URL is provided via arguments (first case)
+if options[:url]
+  send_request(options)
+
+# If no URL provided, enter interactive mode (second case)
+else
+  puts "Welcome to the API Tester!".light_blue
+  puts "Please provide the following details:"
+
+  print "Base URL (e.g., https://example.com/api/v1): ".yellow
+  base_url = gets.chomp
+
+  headers = { "Content-Type" => "application/json" }
+  print "Do you have any additional headers as JSON? (y/n): ".yellow
+  if gets.chomp.downcase == 'y'
+    print "Enter headers as JSON: ".yellow
+    additional_headers = JSON.parse(gets.chomp)
+    headers.merge!(additional_headers)
+  end
+  options[:headers] = headers
+
+  begin
+    loop do
+      print "Endpoint (e.g., /login): ".yellow
+      endpoint = gets.chomp
+      options[:url] = "#{base_url}#{endpoint}"
+
+      print "HTTP Method (GET, POST, PUT, DELETE): ".yellow
+      options[:method] = gets.chomp.upcase
+
+      print "Do you have a request body? (y/n): ".yellow
+      if gets.chomp.downcase == 'y'
+        print "Enter the body as JSON: ".yellow
+        options[:body] = JSON.parse(gets.chomp)
+      else
+        options[:body] = nil
+      end
+
+      print "Do you have a Bearer Token? (y/n): ".yellow
+      if gets.chomp.downcase == 'y'
+        print "Enter the Bearer Token: ".yellow
+        options[:token] = gets.chomp
+      else
+        options[:token] = nil
+      end
+
+      # Send request in loop
+      send_request(options)
+
+      puts "\nPress Ctrl+C to exit or continue with a new request.".light_blue
+    end
+  rescue Interrupt
+    puts "\nExiting API Tester. Goodbye!".red
+  end
+end

data/lib/api_tester/client.rb

@@ -0,0 +1,49 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module ApiTester
+  class Client
+    def initialize(url, headers = {}, method = 'GET', body = nil, token = nil)
+      @uri = URI.parse(url)
+      @headers = headers
+      @method = method
+      @body = body
+      @token = token
+    end
+
+    def send_request
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      http.use_ssl = @uri.scheme == 'https' # Enable SSL for HTTPS
+
+      request = build_request
+      add_auth_token(request) if @token
+
+      response = http.request(request)
+      ApiTester::Response.new(response)
+    end
+
+    private
+
+    def build_request
+      case @method.upcase
+      when 'POST'
+        req = Net::HTTP::Post.new(@uri, @headers)
+        req.body = @body.to_json if @body # Convert body to JSON string
+        req
+      when 'PUT'
+        req = Net::HTTP::Put.new(@uri, @headers)
+        req.body = @body.to_json if @body
+        req
+      when 'DELETE'
+        Net::HTTP::Delete.new(@uri, @headers)
+      else
+        Net::HTTP::Get.new(@uri, @headers)
+      end
+    end
+
+    def add_auth_token(request)
+      request['Authorization'] = "Bearer #{@token}"
+    end
+  end
+end

data/lib/api_tester/helper.rb

@@ -0,0 +1,11 @@
+module ApiTester
+  class Helper
+    def self.get_token_from_env
+      ENV['API_AUTH_TOKEN']
+    end
+
+    def self.format_json(json_string)
+      JSON.pretty_generate(JSON.parse(json_string))
+    end
+  end
+end

data/lib/api_tester/request.rb

@@ -0,0 +1,28 @@
+module ApiTester
+  class Request
+    attr_reader :headers, :method, :body, :token
+
+    def initialize
+      @headers = {}
+      @method = 'GET'
+      @body = nil
+      @token = nil
+    end
+
+    def set_headers(headers)
+      @headers = headers
+    end
+
+    def set_method(method)
+      @method = method.upcase
+    end
+
+    def set_body(body)
+      @body = body
+    end
+
+    def set_auth_token(token)
+      @token = token
+    end
+  end
+end

data/lib/api_tester/response.rb

@@ -0,0 +1,62 @@
+require 'terminal-table'
+
+module ApiTester
+  class Response
+    def initialize(response)
+      @response = response
+    end
+
+    def display
+      # Display status with color
+      display_status
+
+      # Display headers in a table format
+      display_headers
+
+      # Display body
+      display_body
+    end
+
+    private
+
+    def display_status
+      # Use green for 2xx, yellow for 3xx, red for 4xx and 5xx
+      status_code = @response.code.to_i
+      color = case status_code
+              when 200..299 then :green
+              when 300..399 then :yellow
+              else :red
+              end
+
+      puts "\nStatus: #{@response.code}".colorize(color)
+    end
+
+    def display_headers
+      puts "\nHeaders:".light_blue
+
+      # Using Terminal::Table to format headers
+      headers_table = Terminal::Table.new do |t|
+        t.headings = ['Header', 'Value']
+        @response.each_header { |key, value| t.add_row([key, value]) }
+      end
+
+      puts headers_table
+    end
+
+    def display_body
+      puts "\nBody:".light_blue
+
+      if json_response?
+        # Pretty-print JSON with color
+        puts JSON.pretty_generate(JSON.parse(@response.body)).colorize(:light_green)
+      else
+        # Print plain body for non-JSON responses
+        puts @response.body.colorize(:light_yellow)
+      end
+    end
+
+    def json_response?
+      @response['Content-Type'] && @response['Content-Type'].include?('application/json')
+    end
+  end
+end

data/lib/api_tester.rb

@@ -0,0 +1,8 @@
+module ApiTester
+end
+
+# Require all components
+require_relative 'api_tester/client'
+require_relative 'api_tester/request'
+require_relative 'api_tester/response'
+require_relative 'api_tester/helper'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: api-tester-cli
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Bhavyansh Yadav
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+description: This tool allows users to interactively test APIs via the command line.
+email: bhavyansh001@gmail.com
+executables:
+- api-tester
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/api-tester
+- lib/api_tester.rb
+- lib/api_tester/client.rb
+- lib/api_tester/helper.rb
+- lib/api_tester/request.rb
+- lib/api_tester/response.rb
+homepage: https://rubygems.org/gems/api_tester
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/bhavyansh001/api_tester
+  issue_tracker_uri: https://github.com/bhavyansh001/api_tester/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key: 
+specification_version: 4
+summary: A CLI tool to test APIs
+test_files: []