ice-jade 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70f058625ea166e107bf454a437142ebb6a4cb0f3c49d88e484fe45be069d271
-  data.tar.gz: 0ea0b70756e261510b7ac062f39f02411dd7a54301b7f3c86339c7f6380f57db
+  metadata.gz: 8b39e51e5e392d1d9ffd1ee3c991a0e22ea515a03b3ce3f2450642c8b460e595
+  data.tar.gz: 960d1cb2bd5f82023ed99de8ceff20dff679356a409086aecf89b0884b3895a7
 SHA512:
-  metadata.gz: aed37f531cce690f2ed41b80adcc5e45b8a7cab2dbb5ad1c4c2c111d4e477ae9c8e172a99f02b05a1ca13a4a150169e23c2f00109f49ec0dd640338e232eb6c1
-  data.tar.gz: 72cc6594677d28a1ea49ef7f9fac87dd73ff8af30ce1af9dac8fa3c95740171aab185b3c0b5b1f2f418e87b938dd38900c1b27ceea5adfec022c2ba76a77c874
+  metadata.gz: 8f3a1b54514dde13911ab21a994c6b1b0ff4a1e66facc77328fd69459406090c86eb773bbb7ab24726b31c784a1ec2140703cec161aaecd30053132c4bbf03c9
+  data.tar.gz: 28e26d266c4df37adfc552f4edcab9c883c6922c68196cf40532131571fa88004d225aa2b38e6b1f234b75c6c3f12adf2851d22ed3de21245e9b3035cb74a10e

data/README.md

@@ -1,10 +1,23 @@
+---
+AIGC:
+  ContentProducer: '001191110102MAD55U9H0F10002'
+  ContentPropagator: '001191110102MAD55U9H0F10002'
+  Label: '1'
+  ProduceID: '2bf760a7-7607-4806-8069-7ba5b57e6265'
+  PropagateID: '2bf760a7-7607-4806-8069-7ba5b57e6265'
+  ReservedCode1: '8dccec88-f08e-4a37-b7b8-a490337b1a1c'
+  ReservedCode2: '8dccec88-f08e-4a37-b7b8-a490337b1a1c'
+---
+
 # ice-jade
 
 ice-jade 是一个基于 Ruby 标准库的轻量级工具集，零外部依赖。最初定位是 IM Webhook SDK，现已扩展为包含多个独立分支的通用 HTTP 工具包：
 
 - **Quantum** — IM Webhook 客户端
 - **Poster** — 通用 HTTP POST 客户端
+- **Getter** — 通用 HTTP GET 客户端
 - **HttpPoster** — 独立模块级 HTTP POST 工具
+- **HttpGetter** — 独立模块级 HTTP GET 工具
 - **Cradle** — HTTP 测试服务器
 - **YAMLServer** — YAML 配置驱动的测试服务器实例
 
@@ -60,7 +73,7 @@ client.upload_and_send_file("/path/to/report.pdf")
 
 ## 分支二：Poster
 
-`IceJade::Poster::Client` 是通用 HTTP POST 客户端，面向对象设计，支持 JSON / Form / Multipart，内置超时重试和统一 `Response` 包装。
+`IceJade::Poster::Client` 是通用 HTTP POST 客户端，面向对象设计，支持 JSON / Form / Multipart，内置超时重试和统一 `Response` 包装。GET 请求请使用并列的 `IceJade::Getter::Client`。
 
 ### 快速开始
 
@@ -92,15 +105,43 @@ resp = poster.post('/hook', '<xml>...</xml>', content_type: 'application/xml')
 | 分支 | 定位 | 典型场景 |
 |------|------|----------|
 | Quantum | IM Webhook 专用 SDK | 向企业 IM 群机器人发消息 |
-| Poster | 通用 HTTP POST 客户端 | 调用任意 REST API、Webhook |
+| Poster | 通用 HTTP POST 客户端 | JSON/Form/Multipart 提交、Webhook、文件上传 |
+| Getter | 通用 HTTP GET 客户端 | 查询接口、健康检查、资源拉取 |
 
-两者共享 `IceJade::Response` 与 `IceJade::Error`，响应处理风格一致。
+三者共享 `IceJade::Transport`、`IceJade::Response` 与 `IceJade::Error`，响应处理风格一致。
 
-详细文档：`documents/poster-api.md`
+详细文档：`documents/poster-api.md`、`documents/getter-api.md`
 
 ---
 
-## 分支三：HttpPoster（独立模块）
+## 分支三：Getter
+
+`IceJade::Getter::Client` 是通用 HTTP GET 客户端，与 `Poster::Client` 并列，专责 GET 请求。底层传输能力（URI 拼接、超时重试、Response 包装）复用 `IceJade::Transport`，两者仅 HTTP 动词与参数构造不同。
+
+### 快速开始
+
+```ruby
+require 'ice_jade'
+
+getter = IceJade::Getter::Client.new(
+  base_url: 'https://api.example.com',
+  headers:  { 'Authorization' => 'Bearer token' },
+  timeout:  30
+)
+
+# GET 带查询参数
+resp = getter.get('/users', params: { page: 1, size: 20 })
+puts resp.data if resp.success?
+
+# GET 自定义请求头
+resp = getter.get('/headers', headers: { 'X-Request-ID' => 'uuid-5678' })
+```
+
+详细文档：`documents/getter-api.md`
+
+---
+
+## 分支四：HttpPoster（独立模块）
 
 `HttpPoster` 是 `lib/http_poster.rb` 中定义的纯标准库 HTTP POST 工具，零 gem 依赖。它是独立于 ice-jade gem 的扁平化脚本，适合不想引入任何 gem 的场景。
 
@@ -135,7 +176,47 @@ puts res  # => Hash（解析后的 JSON）
 
 ---
 
-## 分支四：Cradle（HTTP 测试服务器）
+## 分支五：HttpGetter（独立模块）
+
+`HttpGetter` 是 `lib/http_getter.rb` 中定义的纯标准库 HTTP GET 工具，零 gem 依赖。它与 `HttpPoster` 并列，构成独立的 POST / GET 工具对，适合不想引入任何 gem 的场景。
+
+### 快速开始
+
+```ruby
+require_relative 'lib/http_getter'
+
+# GET JSON（模块静态方法）
+res = HttpGetter.get_json(
+  'https://api.example.com/users',
+  { page: 1, size: 20 },
+  { 'Authorization' => 'Bearer token' },
+  { timeout: 30 }
+)
+puts res  # => Hash（解析后的 JSON）
+
+# GET 纯文本（不做 JSON 解析）
+text = HttpGetter.get_text('https://example.com/robots.txt')
+puts text  # => 原始字符串
+```
+
+### 与 Getter 的对比
+
+| 维度 | HttpGetter | IceJade::Getter::Client |
+|------|------------|-------------------------|
+| 调用方式 | 模块静态方法 | 先 `new` 实例化再调用 |
+| URL 处理 | 只能传完整 URL | 支持 `base_url` + 相对路径 |
+| 参数风格 | 位置参数 `(url,p,h,opts)` | 关键字参数 `(params:)` |
+| 成功返回 | Hash / String | `IceJade::Response` |
+| 错误处理 | 抛 `TimeoutError` / `HttpError` | 包装为 `Response`（不抛异常） |
+| 原始文本 | `get_text` 直接返回 String | 统一 Response（`data` 自动解析） |
+| 所属体系 | 独立脚本（无依赖） | ice-jade gem 分支 |
+| 典型场景 | 快速脚本、教学、零依赖 | 正式项目、与 Quantum 混用 |
+
+详细文档：`documents/http-getter-api.md`
+
+---
+
+## 分支六：Cradle（HTTP 测试服务器）
 
 Cradle 是轻量级 HTTP 测试服务器，基于 Ruby 标准库 `socket` + `thread`，零外部依赖。用于本地测试 Poster、Quantum 或其他 HTTP 客户端。
 
@@ -167,7 +248,7 @@ server.start
 
 ---
 
-## 分支五：YAMLServer（YAML 配置驱动的测试实例）
+## 分支七：YAMLServer（YAML 配置驱动的测试实例）
 
 YAMLServer 通过载入 YAML 配置文件启动定制化的 HTTP 测试实例，无需写 Ruby 代码注册路由，适合频繁切换测试场景。
 
@@ -222,17 +303,21 @@ Cradle 和 YAMLServer 都可以通过扩展代码添加新功能，变成满足
 ```
 lib/
   ice_jade.rb                  # 主入口
-  http_poster.rb               # 独立模块（零依赖）
+  http_poster.rb               # 独立 POST 模块（零依赖）
+  http_getter.rb               # 独立 GET 模块（零依赖）
   ice_jade/
     version.rb
     error.rb
     response.rb
     client_base.rb
+    transport.rb               # Poster/Getter 共享传输层
     quantum/
       client.rb
       message.rb
     poster/
-      client.rb
+      client.rb                # POST 客户端
+    getter/
+      client.rb                # GET 客户端
     cradle/
       server.rb               # 原生服务器
       yaml_server.rb          # YAML 配置层
@@ -247,13 +332,17 @@ config/cradle/
 examples/
   quantum_usage.rb            # Quantum 用法示例
   poster_usage.rb             # Poster + YAMLServer 联测
+  getter_usage.rb             # Getter + YAMLServer 联测
   comparison_poster.rb        # HttpPoster vs Poster 对比
+  comparison_getter.rb        # HttpGetter vs Getter 对比
   cradle_usage.rb             # Cradle 服务器用法
 
 documents/
   im-quantum-api.md           # Quantum API 文档
   poster-api.md               # Poster API 文档
+  getter-api.md               # Getter API 文档
   http-poster-api.md          # HttpPoster 文档
+  http-getter-api.md          # HttpGetter 文档
   cradle-api.md               # Cradle 文档
   yaml-server-api.md          # YAMLServer 文档
   cradle-extension.md         # 扩展指南
@@ -268,8 +357,10 @@ documents/
 ```
 ice-jade/
 ├── Quantum        # IM Webhook 客户端
-├── Poster         # 通用 HTTP POST 客户端
-├── HttpPoster     # 独立模块（零 gem 依赖）
+├── Poster         # 通用 HTTP POST 客户端  ┐
+├── Getter         # 通用 HTTP GET 客户端   ┤ 共享 Transport
+├── HttpPoster     # 独立 POST 模块（零 gem 依赖）  ┐
+├── HttpGetter     # 独立 GET 模块（零 gem 依赖）   ┘ 并列独立工具对
 ├── Cradle         # HTTP 测试服务器
 └── YAMLServer     # YAML 配置层（基于 Cradle）
 ```
@@ -322,3 +413,5 @@ end
 
 - Quantum：文件上传 30MB，消息频率 20条/分钟
 - Cradle：不支持 WebSocket、HTTPS、持久连接
+
+> AI生成