yobi-http 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88846b024d2d475d692092a342ac7d178b24821994aef0cd3e70b4c914980f09
-  data.tar.gz: 6cc5fbd3fb14e49c347cf8d866d2626e9a2174a8a6054fbc7d02d7a957c8416c
+  metadata.gz: 445677da2c43e5f1e160b463c4e188b9a48a6536dc89b6c54ae8456327e2a302
+  data.tar.gz: 6f2d45e33717d7aec6cc54fc0372bd206018ced1cc73d4d81535acb1d6f5b027
 SHA512:
-  metadata.gz: 4085882260b11117520ab7f9390054a9df61696ef5abdac57c8e7264e5971dff658f6e23aa531e5142e25acc0bd0ed24c4ca555270023091d7b5f8ca74ceb34c
-  data.tar.gz: e86d070c44208636e3377ad0f83b0657a12bce7f0e129b904781d3eceda159764f755eb4ee0d63d4df77eafc73d05e362f830e4d38f9fbd523c07553f9da489b
+  metadata.gz: efe2e6ed336f584d35c776b89db1cf30ee585f4af398bafd3dbb873a92bc96865c2c3be68af9557d0c748110962ad96f222fda4a122952d3180cc9ab46697cbb
+  data.tar.gz: a05e99fa52716827a7e44f42630dd5c5460aa80829bd08f3e6fed5e795ce966b2afdbbbbaa82b84670ed99e8502189a44337a03489321189e6039bc00f085588

data/Agents.md

@@ -0,0 +1,389 @@
+# Yobi HTTP Client - Technical Documentation
+
+## Overview
+
+Yobi (呼び) is a lightweight Ruby HTTP client designed for testing APIs from the command line. It provides a simple and efficient way to make HTTP requests with human-friendly output formatting, inspired by HTTPie.
+
+**Key Features:**
+- Simple command-line interface
+- Support for all standard HTTP methods (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS)
+- JSON formatting and syntax highlighting
+- Multiple authentication methods
+- Customizable output formats
+- Offline mode for request debugging
+- Raw output mode for piping to other tools
+
+## System Requirements
+
+- Ruby >= 3.0.0
+- RubyGems package manager
+
+## Installation
+
+### Install from RubyGems
+
+The simplest way to install Yobi is through RubyGems:
+
+```bash
+gem install yobi-http
+```
+
+### Install from Source
+
+Clone the repository and install locally:
+
+```bash
+git clone https://github.com/dvinciguerra/yobi-http.git
+cd yobi-http
+bundle install
+bundle exec rake install
+```
+
+### Verify Installation
+
+Check that Yobi is installed correctly:
+
+```bash
+yobi --version
+```
+
+## Usage
+
+### Basic Syntax
+
+```bash
+yobi [METHOD] <url> [HEADER:VALUE] [key=value]
+```
+
+### HTTP Methods
+
+Yobi supports all standard HTTP methods:
+
+- **GET** - Retrieve resources (default method)
+- **POST** - Create new resources
+- **PUT** - Update existing resources
+- **DELETE** - Remove resources
+- **PATCH** - Partially update resources
+- **HEAD** - Get resource headers only
+- **OPTIONS** - Get available methods
+
+### Basic Examples
+
+#### Simple GET Request
+
+```bash
+yobi GET https://jsonplaceholder.typicode.com/posts/1
+```
+
+Or simply (GET is the default):
+
+```bash
+yobi https://jsonplaceholder.typicode.com/posts/1
+```
+
+#### POST Request with Data
+
+```bash
+yobi POST https://jsonplaceholder.typicode.com/posts title="foo" body="bar" userId=1
+```
+
+#### Request with Custom Headers
+
+```bash
+yobi GET https://jsonplaceholder.typicode.com/posts/1 Authorization:"Bearer <token>"
+```
+
+#### Using Localhost Shorthand
+
+```bash
+yobi :8080/api/items
+# Expands to: http://localhost:8080/api/items
+```
+
+### Authentication
+
+#### Basic Authentication
+
+```bash
+yobi -A basic -a username:password https://api.example.com/secure-data
+```
+
+#### Bearer Token Authentication
+
+```bash
+yobi -A bearer -a YOUR_TOKEN https://api.example.com/secure-data
+```
+
+Or use a header directly:
+
+```bash
+yobi GET https://api.example.com/secure-data Authorization:"Bearer YOUR_TOKEN"
+```
+
+### Command-Line Options
+
+#### Output Control
+
+**Print Format (`-p`, `--print`)**
+
+Control what parts of the response to display:
+
+- `H` - Print headers only
+- `B` - Print body only
+- `HB` - Print headers and body (default)
+
+```bash
+yobi --print B https://api.example.com/data
+```
+
+**Raw Output (`--raw`)**
+
+Print raw response without formatting (useful for piping to other tools):
+
+```bash
+yobi --raw --print B POST https://httpbin.org/anything | jq '.headers["User-Agent"]'
+```
+
+#### Authentication Options
+
+- `-a, --auth USER:PASS` - Specify authentication credentials
+- `-A, --auth-type TYPE` - Specify authentication type (basic, bearer)
+
+```bash
+yobi -A basic -a user:pass https://api.example.com/secure
+```
+
+#### Debugging Options
+
+**Verbose Mode (`-v`, `--verbose`)**
+
+Print detailed request and response information:
+
+```bash
+yobi -v GET https://api.example.com/users
+```
+
+**Offline Mode (`--offline`)**
+
+Prepare the request without sending it (useful for debugging):
+
+```bash
+yobi --offline POST https://api.example.com/users name=John age=30
+```
+
+**Debug Environment Variable**
+
+Enable debug output with environment variable:
+
+```bash
+YOBI_DEBUG=1 yobi GET https://api.example.com/users
+```
+
+#### Other Options
+
+- `-h, --help` - Display help message
+- `--version` - Display version information
+
+## Advanced Usage
+
+### Combining Multiple Parameters
+
+You can combine headers and data in a single request:
+
+```bash
+yobi POST https://api.example.com/users \
+  name=John \
+  email=john@example.com \
+  Authorization:"Bearer token123" \
+  Content-Type:"application/json"
+```
+
+### Working with Different Content Types
+
+By default, Yobi uses `application/json`. Override with custom headers:
+
+```bash
+yobi POST https://api.example.com/form \
+  username=john \
+  password=secret \
+  Content-Type:"application/x-www-form-urlencoded"
+```
+
+### Piping Output
+
+Use raw mode to pipe output to other command-line tools:
+
+```bash
+# Extract specific fields with jq
+yobi --raw --print B GET https://api.example.com/users | jq '.[0].name'
+
+# Save response to file
+yobi --raw --print B GET https://api.example.com/data > response.json
+
+# Count lines in response
+yobi --raw --print B GET https://api.example.com/logs | wc -l
+```
+
+## Development
+
+### Setting Up Development Environment
+
+1. Clone the repository:
+```bash
+git clone https://github.com/dvinciguerra/yobi-http.git
+cd yobi-http
+```
+
+2. Install dependencies:
+```bash
+bin/setup
+```
+
+3. Run the interactive console:
+```bash
+bin/console
+```
+
+### Building the Gem
+
+To build the gem locally:
+
+```bash
+bundle exec rake build
+```
+
+The gem file will be created in the `pkg/` directory.
+
+### Installing Local Development Version
+
+```bash
+bundle exec rake install
+```
+
+### Running Tests
+
+```bash
+bundle exec rake test
+```
+
+### Code Quality
+
+Check code style with RuboCop:
+
+```bash
+rubocop
+```
+
+### Release Process
+
+1. Update version in `lib/yobi.rb`
+2. Update `CHANGELOG.md`
+3. Run tests and ensure they pass
+4. Create release:
+```bash
+bundle exec rake release
+```
+
+This will:
+- Create a git tag for the version
+- Build and push the gem to RubyGems
+- Push commits and tags to GitHub
+
+## Project Structure
+
+```
+yobi-http/
+├── exe/
+│   └── yobi              # Main executable
+├── lib/
+│   ├── yobi.rb          # Core module and version
+│   ├── yobi/
+│   │   └── http.rb      # HTTP constants
+│   └── views/           # Output templates
+├── bin/
+│   ├── setup            # Development setup script
+│   └── console          # Interactive console
+├── yobi.gemspec         # Gem specification
+└── README.md            # User documentation
+```
+
+## Dependencies
+
+- **tty-markdown (~> 0.7)** - Markdown rendering with syntax highlighting for formatted output
+
+## Technical Details
+
+### URL Resolution
+
+Yobi intelligently resolves URLs:
+
+- Full URLs: `https://api.example.com/path`
+- Without protocol: `api.example.com/path` → `http://api.example.com/path`
+- Localhost shorthand: `:8080/path` → `http://localhost:8080/path`
+
+### Request Processing
+
+1. Parse command-line arguments and options
+2. Resolve HTTP method (defaults to GET)
+3. Resolve and normalize URL
+4. Parse data parameters (key=value format)
+5. Parse headers (Header:Value format)
+6. Apply authentication if specified
+7. Send request or prepare offline mode
+8. Format and display response
+
+### Response Formatting
+
+- JSON responses are automatically pretty-printed
+- Markdown-based output with syntax highlighting
+- Configurable output sections (headers, body, or both)
+- Raw mode for integration with other tools
+
+## Troubleshooting
+
+### Common Issues
+
+**"command not found: yobi"**
+- Ensure gem bin directory is in your PATH
+- Try `bundle exec yobi` if running from source
+
+**SSL Certificate Errors**
+- Update system certificates
+- Check Ruby OpenSSL installation
+
+**JSON Parsing Errors**
+- Use `--raw` mode to see actual response
+- Verify API is returning valid JSON
+
+**Permission Denied**
+- Use `gem install --user-install yobi-http` for user-level installation
+- Or use `sudo gem install yobi-http` for system-wide installation
+
+## Contributing
+
+Contributions are welcome! Please follow these guidelines:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests if applicable
+5. Ensure code passes RuboCop checks
+6. Submit a pull request
+
+See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for community guidelines.
+
+## License
+
+This project is open source. See the repository for license details.
+
+## Resources
+
+- **GitHub Repository**: https://github.com/dvinciguerra/yobi-http
+- **RubyGems Package**: https://rubygems.org/gems/yobi-http
+- **Changelog**: https://github.com/dvinciguerra/yobi-http/blob/main/CHANGELOG.md
+- **Code of Conduct**: https://github.com/dvinciguerra/yobi-http/blob/main/CODE_OF_CONDUCT.md
+
+## Support
+
+For bugs and feature requests, please open an issue on GitHub:
+https://github.com/dvinciguerra/yobi-http/issues

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.4.1]
+
+- Fix Time requirement
+- Change Time format to match HTTP standard
+
+## [0.4.0] - 2026-10-01
+
+- Add offline mode feature
+- Solve part of header showing always
+
 ## [0.1.0] - 2026-02-10
 
 - Initial release

data/exe/yobi

@@ -8,6 +8,7 @@ require "erb"
 require "json"
 require "net/http"
 require "optparse"
+require "time"
 require "tty-markdown"
 require "uri"
 
@@ -125,17 +126,10 @@ Net::HTTP.start(URI(url).host, URI(url).port, use_ssl: URI(url).scheme == "https
     response["Access-Control-Allow-Credentials"] = true
     response["Access-Control-Allow-Origin"] = "*"
     response["Connection"] = "close"
-    response["Date"] = Time.now.iso8601
+    response["Date"] = Time.now.httpdate
     response["Server"] = "yobi-offline/#{Yobi::VERSION}"
     response["X-Powered-By"] = "Yobi/#{Yobi::VERSION}"
-
-    body = JSON.pretty_generate({
-                                           method: method,
-                                           url: url,
-                                           headers: headers,
-                                           body: request.body,
-                                           options: options
-                                         })
+    response.body = body = JSON.pretty_generate({ message: "Offline mode enabled" })
 
     view = Yobi.view(:output)
     puts TTY::Markdown.parse(ERB.new(view).result(binding), color: :always)

data/lib/yobi.rb

@@ -10,7 +10,7 @@ module Yobi
   class Error < StandardError; end
 
   # Yobi gem version
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 
 
   def self.name

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yobi-http
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Daniel Vinciguerra
 bindir: exe
 cert_chain: []
-date: 2026-02-12 00:00:00.000000000 Z
+date: 2026-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-markdown
@@ -32,6 +32,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- Agents.md
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - README.md