ice-jade 0.5.0 → 0.7.0

data/lib/ice_jade/poster/client.rb

@@ -1,11 +1,6 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'json'
-require 'uri'
-require 'securerandom'
-require_relative '../response'
-require_relative '../error'
+require_relative '../transport'
 
 module IceJade
   module Poster
@@ -13,6 +8,7 @@ module IceJade
     #
     # 零外部依赖，支持 JSON / Form / Multipart 三种常用提交方式，
     # 内置超时控制、指数退避重试、统一 Response 包装，与 Quantum 模块风格一致。
+    # 底层传输能力（URI 拼接、请求执行、响应适配、超时重试）复用 IceJade::Transport，
     #
     # @example 基础用法
     #   poster = IceJade::Poster::Client.new(
@@ -24,7 +20,7 @@ module IceJade
     #   puts resp.data if resp.success?
     #
     class Client
-      attr_reader :base_url, :default_headers, :timeout, :open_timeout, :max_retries
+      include IceJade::Transport
 
       # @param base_url     [String, nil] 基础 URL，后续请求可传相对路径
       # @param headers      [Hash] 默认请求头（每次请求自动合并，同名会被覆盖）
@@ -32,11 +28,9 @@ module IceJade
       # @param open_timeout [Integer] 连接超时（秒），默认 10
       # @param max_retries  [Integer] 超时后最大重试次数，默认 2
       def initialize(base_url: nil, headers: {}, timeout: 60, open_timeout: 10, max_retries: 2)
-        @base_url = base_url ? base_url.to_s.chomp('/') : nil
-        @default_headers = normalize_headers(headers)
-        @timeout = timeout
-        @open_timeout = open_timeout
-        @max_retries = max_retries
+        init_transport(base_url: base_url, headers: headers,
+                       timeout: timeout, open_timeout: open_timeout,
+                       max_retries: max_retries)
       end
 
       # ------------------------------------------------------------------
@@ -101,14 +95,7 @@ module IceJade
 
       private
 
-      def build_uri(url)
-        if base_url && !url.to_s.start_with?('http')
-          URI.parse("#{base_url}#{url}")
-        else
-          URI.parse(url.to_s)
-        end
-      end
-
+      # 构造 POST 请求对象（JSON / Form / 自定义 Content-Type 三种序列化分支）
       def build_request(uri, body, content_type, headers)
         req = Net::HTTP::Post.new(uri)
         apply_headers(req, headers)
@@ -127,122 +114,6 @@ module IceJade
 
         req
       end
-
-      def apply_headers(req, headers)
-        headers.each do |k, v|
-          req[k.to_s] = v.to_s
-        end
-      end
-
-      def normalize_headers(h)
-        h.transform_keys(&:to_s).transform_values(&:to_s)
-      end
-
-      def merge_headers(base, extra)
-        base.merge(extra)
-      end
-
-      def execute(uri, request)
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = uri.scheme == 'https'
-        http.open_timeout = open_timeout
-        http.read_timeout = timeout
-
-        retries = 0
-        begin
-          response = http.request(request)
-          Response.new(adapt_response(response))
-        rescue Net::OpenTimeout, Net::ReadTimeout => e
-          retries += 1
-          if retries <= max_retries
-            sleep(2**retries)
-            retry
-          end
-          Response.new({ 'ok' => false, 'code' => 0,
-                         'message' => "Timeout after #{max_retries} retries: #{e.message}", 'data' => nil })
-        rescue StandardError => e
-          Response.new({ 'ok' => false, 'code' => 0, 'message' => e.message, 'data' => nil })
-        ensure
-          http.finish if http.started?
-        end
-      end
-
-      # 内置 HTTP 状态码文本（兼容各 Ruby 版本）
-      HTTP_STATUS_TEXT = {
-        100 => 'Continue', 101 => 'Switching Protocols',
-        200 => 'OK', 201 => 'Created', 202 => 'Accepted',
-        204 => 'No Content',
-        301 => 'Moved Permanently', 302 => 'Found', 304 => 'Not Modified',
-        400 => 'Bad Request', 401 => 'Unauthorized', 403 => 'Forbidden',
-        404 => 'Not Found', 405 => 'Method Not Allowed',
-        429 => 'Too Many Requests',
-        500 => 'Internal Server Error', 502 => 'Bad Gateway',
-        503 => 'Service Unavailable'
-      }.freeze
-
-      def adapt_response(response)
-        body = response.body.to_s
-        code = response.code.to_i
-
-        data = begin
-                 JSON.parse(body)
-               rescue JSON::ParserError
-                 body
-               end
-
-        {
-          'ok' => code >= 200 && code < 300,
-          'code' => code,
-          'message' => HTTP_STATUS_TEXT[code] || 'Unknown',
-          'data' => data
-        }
-      end
-
-      def build_multipart(params)
-        boundary = "----IceJadePosterBoundary#{SecureRandom.hex(16)}"
-        body = +"".b
-
-        params.each do |key, value|
-          if value.is_a?(String) && File.exist?(value)
-            filename = File.basename(value)
-            file_data = File.binread(value)
-            mime = mime_type(filename)
-            body << "--#{boundary}\r\n"
-            body << %(Content-Disposition: form-data; name="#{key}"; filename="#{filename}") << "\r\n"
-            body << "Content-Type: #{mime}" << "\r\n\r\n"
-            body << file_data.b
-            body << "\r\n"
-          else
-            body << "--#{boundary}\r\n"
-            body << %(Content-Disposition: form-data; name="#{key}") << "\r\n\r\n"
-            body << value.to_s
-            body << "\r\n"
-          end
-        end
-
-        body << "--#{boundary}--\r\n"
-        [body, boundary]
-      end
-
-      def mime_type(filename)
-        ext = File.extname(filename).downcase
-        case ext
-        when '.png'            then 'image/png'
-        when '.jpg', '.jpeg'   then 'image/jpeg'
-        when '.gif'            then 'image/gif'
-        when '.webp'           then 'image/webp'
-        when '.bmp'            then 'image/bmp'
-        when '.pdf'            then 'application/pdf'
-        when '.txt'            then 'text/plain'
-        when '.json'           then 'application/json'
-        when '.zip'            then 'application/zip'
-        when '.doc'            then 'application/msword'
-        when '.docx'           then 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
-        when '.xls'            then 'application/vnd.ms-excel'
-        when '.xlsx'           then 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
-        else                        'application/octet-stream'
-        end
-      end
     end
   end
 end

data/lib/ice_jade/transport.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+require 'securerandom'
+require_relative 'response'
+require_relative 'error'
+
+module IceJade
+  # HTTP 传输层共享逻辑
+  #
+  # Poster::Client 与 Getter::Client 共用的底层能力：
+  # base_url 拼接、默认头合并、Net::HTTP 执行、超时指数退避重试、
+  # 状态码/JSON 解析/Response 包装。
+  #
+  # 设计为 instance 方法模块，由两个 Client 类 include 后复用，
+  # 各自只关心自己负责的 HTTP 动词与参数构造，传输细节由 Transport 统一。
+  module Transport
+    # 公共初始化参数解析，供两个 Client 的 #initialize 调用
+    #
+    # @param base_url     [String, nil] 基础 URL，后续请求可传相对路径
+    # @param headers      [Hash] 默认请求头（每次请求自动合并，同名会被覆盖）
+    # @param timeout      [Integer] 读取超时（秒）
+    # @param open_timeout [Integer] 连接超时（秒）
+    # @param max_retries  [Integer] 超时后最大重试次数
+    def init_transport(base_url:, headers:, timeout:, open_timeout:, max_retries:)
+      @base_url = base_url ? base_url.to_s.chomp('/') : nil
+      @default_headers = normalize_headers(headers)
+      @timeout = timeout
+      @open_timeout = open_timeout
+      @max_retries = max_retries
+    end
+
+    attr_reader :base_url, :default_headers, :timeout, :open_timeout, :max_retries
+
+    # 拼接 base_url 与相对路径，或直接解析完整 URL
+    #
+    # @param url [String] 完整 URL 或相对路径（需先设置 base_url）
+    # @return [URI::Generic]
+    def build_uri(url)
+      if base_url && !url.to_s.start_with?('http')
+        URI.parse("#{base_url}#{url}")
+      else
+        URI.parse(url.to_s)
+      end
+    end
+
+    # 将头 Hash 写入 Net::HTTP 请求对象
+    def apply_headers(req, headers)
+      headers.each do |k, v|
+        req[k.to_s] = v.to_s
+      end
+    end
+
+    # 头键值统一字符串化
+    def normalize_headers(h)
+      h.transform_keys(&:to_s).transform_values(&:to_s)
+    end
+
+    # 默认头与额外头合并（额外同名覆盖）
+    def merge_headers(base, extra)
+      base.merge(extra)
+    end
+
+    # 执行 Net::HTTP 请求，超时指数退避重试，异常包装为 Response
+    #
+    # @param uri     [URI::Generic]
+    # @param request [Net::HTTPGenericRequest]
+    # @return [IceJade::Response]
+    def execute(uri, request)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      http.open_timeout = open_timeout
+      http.read_timeout = timeout
+
+      retries = 0
+      begin
+        response = http.request(request)
+        Response.new(adapt_response(response))
+      rescue Net::OpenTimeout, Net::ReadTimeout => e
+        retries += 1
+        if retries <= max_retries
+          sleep(2**retries)
+          retry
+        end
+        Response.new({ 'ok' => false, 'code' => 0,
+                       'message' => "Timeout after #{max_retries} retries: #{e.message}", 'data' => nil })
+      rescue StandardError => e
+        Response.new({ 'ok' => false, 'code' => 0, 'message' => e.message, 'data' => nil })
+      ensure
+        http.finish if http.started?
+      end
+    end
+
+    # 内置 HTTP 状态码文本（兼容各 Ruby 版本）
+    HTTP_STATUS_TEXT = {
+      100 => 'Continue', 101 => 'Switching Protocols',
+      200 => 'OK', 201 => 'Created', 202 => 'Accepted',
+      204 => 'No Content',
+      301 => 'Moved Permanently', 302 => 'Found', 304 => 'Not Modified',
+      400 => 'Bad Request', 401 => 'Unauthorized', 403 => 'Forbidden',
+      404 => 'Not Found', 405 => 'Method Not Allowed',
+      429 => 'Too Many Requests',
+      500 => 'Internal Server Error', 502 => 'Bad Gateway',
+      503 => 'Service Unavailable'
+    }.freeze
+
+    # 将 Net::HTTP 响应适配为 IceJade::Response 所需的 Hash
+    #
+    # @param response [Net::HTTPResponse]
+    # @return [Hash] 形如 { 'ok' => bool, 'code' => int, 'message' => str, 'data' => data }
+    def adapt_response(response)
+      body = response.body.to_s
+      code = response.code.to_i
+
+      data = begin
+               JSON.parse(body)
+             rescue JSON::ParserError
+               body
+             end
+
+      {
+        'ok' => code >= 200 && code < 300,
+        'code' => code,
+        'message' => HTTP_STATUS_TEXT[code] || 'Unknown',
+        'data' => data
+      }
+    end
+
+    # multipart 边界生成与 MIME 推断 —— POST 专用，Getter 不使用，
+    # 但为保持 Transport 的自包含性一并放在这里，供 Poster::Client 复用。
+    def build_multipart(params)
+      boundary = "----IceJadeTransportBoundary#{SecureRandom.hex(16)}"
+      body = +"".b
+
+      params.each do |key, value|
+        if value.is_a?(String) && File.exist?(value)
+          filename = File.basename(value)
+          file_data = File.binread(value)
+          mime = mime_type(filename)
+          body << "--#{boundary}\r\n"
+          body << %(Content-Disposition: form-data; name="#{key}"; filename="#{filename}") << "\r\n"
+          body << "Content-Type: #{mime}" << "\r\n\r\n"
+          body << file_data.b
+          body << "\r\n"
+        else
+          body << "--#{boundary}\r\n"
+          body << %(Content-Disposition: form-data; name="#{key}") << "\r\n\r\n"
+          body << value.to_s
+          body << "\r\n"
+        end
+      end
+
+      body << "--#{boundary}--\r\n"
+      [body, boundary]
+    end
+
+    def mime_type(filename)
+      ext = File.extname(filename).downcase
+      case ext
+      when '.png'            then 'image/png'
+      when '.jpg', '.jpeg'   then 'image/jpeg'
+      when '.gif'            then 'image/gif'
+      when '.webp'           then 'image/webp'
+      when '.bmp'            then 'image/bmp'
+      when '.pdf'            then 'application/pdf'
+      when '.txt'            then 'text/plain'
+      when '.json'           then 'application/json'
+      when '.zip'            then 'application/zip'
+      when '.doc'            then 'application/msword'
+      when '.docx'           then 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+      when '.xls'            then 'application/vnd.ms-excel'
+      when '.xlsx'           then 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+      else                        'application/octet-stream'
+      end
+    end
+  end
+end

data/lib/ice_jade/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IceJade
-  VERSION = '0.5.0'
+  VERSION = '0.7.0'
 end

data/lib/ice_jade.rb

@@ -10,4 +10,5 @@ require_relative 'ice_jade/client_base'
 require_relative 'ice_jade/quantum/client'
 require_relative 'ice_jade/quantum/message'
 require_relative 'ice_jade/poster'
+require_relative 'ice_jade/getter'
 require_relative 'ice_jade/cradle'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ice-jade
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Frampt
@@ -9,8 +9,9 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: A lightweight Ruby SDK featuring Quantum (IM robot messaging) and Poster
-  (zero-dependency HTTP POST client with JSON/Form/Multipart support).
+description: A lightweight Ruby SDK featuring Quantum (IM robot messaging), Getter
+  & Poster (zero-dependency HTTP GET & POST clients with JSON/Form/Multipart support
+  and sharing a common IceJade::Transport layer).
 email:
 - 18995691365@189.cn
 executables:
@@ -23,6 +24,14 @@ files:
 - README.md
 - bin/cradle
 - bin/cradle-instance
+- config/cradle/poster_test.yml
+- examples/comparison_getter.rb
+- examples/comparison_poster.rb
+- examples/cradle_usage.rb
+- examples/getter_usage.rb
+- examples/poster_usage.rb
+- examples/quantum_usage.rb
+- lib/http_getter.rb
 - lib/http_poster.rb
 - lib/ice_jade.rb
 - lib/ice_jade/client_base.rb
@@ -30,11 +39,14 @@ files:
 - lib/ice_jade/cradle/server.rb
 - lib/ice_jade/cradle/yaml_server.rb
 - lib/ice_jade/error.rb
+- lib/ice_jade/getter.rb
+- lib/ice_jade/getter/client.rb
 - lib/ice_jade/poster.rb
 - lib/ice_jade/poster/client.rb
 - lib/ice_jade/quantum/client.rb
 - lib/ice_jade/quantum/message.rb
 - lib/ice_jade/response.rb
+- lib/ice_jade/transport.rb
 - lib/ice_jade/version.rb
 homepage: https://www.srdcloud.cn/codehub/Frampt/ice-jade
 licenses:
@@ -56,5 +68,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: IM webhook SDK & general-purpose HTTP POST client
+summary: IM webhook SDK & general-purpose HTTP POST/GET client
 test_files: []