ve-tos-ruby-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30e5d9300d235ffbbd406f29793424c09d903c4a720b9015307bf1e56f111665
+  data.tar.gz: 7f3aaf5b4880ecc5bd372c7de50a53234a2ede71669f28a6fd74871775667aaf
+SHA512:
+  metadata.gz: 2637093b77a69369532f95e01179d3badaccf9ee2199bd65c44f1b3e738185446ce561562a2bfc9302a1d87b8bf8f0b9edeb79267612b81978bcf1430f8938ac
+  data.tar.gz: e30a3db93b8c50595f2571a919852c5e3ce0b7c8493b79a04f39135511b2a9675a77447ad8fbbad90c0bbca14db8c1409cecf95bf9b745085fab7e1322ba88bf

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,93 @@
+# ve-tos-ruby-sdk
+
+Ruby SDK for [Volcengine TOS](https://www.volcengine.com/docs/6349).
+
+- `PutObject`, `GetObject` (with Range), `HeadObject`, `DeleteObject`
+- `DeleteMultipleObjects` (batch)
+- `ListObjectsV2` (with prefix + pagination)
+- Presigned URLs (GET / PUT)
+
+Authentication uses `TOS4-HMAC-SHA256` (the TOS variant of AWS SigV4).
+
+## Installation
+
+```ruby
+# Gemfile
+gem "ve-tos-ruby-sdk"
+```
+
+## Usage
+
+```ruby
+client = TOS::Client.new(
+  access_key_id: ENV.fetch("TOS_ACCESS_KEY_ID"),
+  secret_access_key: ENV.fetch("TOS_SECRET_ACCESS_KEY"),
+  region: "cn-beijing"
+  # endpoint: "tos-cn-beijing.volces.com"  # optional override
+)
+
+bucket = client.bucket("my-bucket")
+
+# Upload
+bucket.put_object("hello.txt", "world", content_type: "text/plain")
+
+# Download (full body)
+res = bucket.get_object("hello.txt")
+res.body # => "world"
+
+# Download (streaming)
+File.open("/tmp/out.bin", "wb") do |f|
+  bucket.get_object("big.bin") { |chunk| f.write(chunk) }
+end
+
+# Range request
+bucket.get_object("big.bin", range: 0..1023) # first 1 KiB
+
+# Metadata
+bucket.head_object("hello.txt").header("content-length")
+
+# Delete
+bucket.delete_object("hello.txt")
+bucket.delete_multiple_objects(%w[a.txt b.txt c.txt])
+
+# List
+page = bucket.list_objects(prefix: "uploads/", max_keys: 100)
+page[:keys] # => ["uploads/foo.png", ...]
+
+# Presigned URL (read)
+url = client.presign(method: "GET", bucket: "my-bucket", key: "hello.txt", expires_in: 600)
+```
+
+## Errors
+
+All HTTP errors raise `TOS::ServerError`, which carries `status`, `code`, `request_id`, and `body`. Network failures raise `TOS::NetworkError`. Configuration mistakes raise `TOS::ConfigError`.
+
+```ruby
+begin
+  bucket.get_object("missing")
+rescue TOS::ServerError => e
+  e.status     # => 404
+  e.code       # => "NoSuchKey"
+  e.request_id # => "..."
+end
+```
+
+## Out of scope
+
+This SDK is intentionally narrow. The following are not implemented; if you need them, the `Client#request` method gives you a signed-request escape hatch:
+
+- Multipart upload (initiate / upload-part / complete / abort)
+- Bucket-level operations (create, lifecycle, CORS, ACL, tagging)
+- Object copy / append / restore
+- Server-side encryption headers, object tagging
+
+## Development
+
+```
+bundle install
+bundle exec rspec
+```
+
+## License
+
+Apache License 2.0

data/lib/tos/bucket.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "rexml/document"
+
+module TOS
+  # All operations are bucket-scoped: get a bucket via `client.bucket(name)`
+  # then call put_object / get_object / etc. on it.
+  class Bucket
+    attr_reader :name, :client
+
+    def initialize(client:, name:)
+      raise ConfigError, "bucket name is required" if name.to_s.empty?
+
+      @client = client
+      @name = name.to_s
+    end
+
+    def put_object(key, body, content_type: nil, content_md5: nil, metadata: {}, headers: {})
+      h = headers.dup
+      h["Content-Type"] = content_type if content_type
+      h["Content-MD5"] = content_md5 if content_md5
+      metadata.each { |k, v| h["x-tos-meta-#{k}"] = v.to_s }
+
+      body_str = body.respond_to?(:read) ? body.read : body.to_s
+      client.request(method: :put, host: host, path: path_for(key), headers: h, body: body_str)
+    end
+
+    # Returns the response with the body loaded. For large objects, pass a
+    # block which receives streamed chunks.
+    def get_object(key, range: nil, headers: {}, &block)
+      h = headers.dup
+      h["Range"] = format_range(range) if range
+
+      client.request(method: :get, host: host, path: path_for(key), headers: h, stream: block)
+    end
+
+    def head_object(key, headers: {})
+      client.request(method: :head, host: host, path: path_for(key), headers: headers)
+    end
+
+    def delete_object(key)
+      client.request(method: :delete, host: host, path: path_for(key))
+    end
+
+    # Lists up to `max_keys` objects under `prefix`. Pass the previous
+    # response's `next_continuation_token` to page through results.
+    #
+    # Returns a Hash:
+    #   {
+    #     keys: ["foo/bar.txt", ...],
+    #     is_truncated: true|false,
+    #     next_continuation_token: "...",
+    #     raw: TOS::Response
+    #   }
+    def list_objects(prefix: nil, max_keys: 1000, continuation_token: nil)
+      query = { "list-type" => "2", "max-keys" => max_keys.to_s }
+      query["prefix"] = prefix if prefix
+      query["continuation-token"] = continuation_token if continuation_token
+
+      res = client.request(method: :get, host: host, path: "/", query: query)
+      parse_list_response(res)
+    end
+
+    # Deletes up to 1000 objects in a single request.
+    def delete_multiple_objects(keys, quiet: true)
+      keys = Array(keys).reject { |k| k.to_s.empty? }
+      return [] if keys.empty?
+
+      body = build_delete_payload(keys, quiet)
+      content_md5 = OpenSSL::Digest::MD5.base64digest(body)
+
+      client.request(
+        method: :post,
+        host: host,
+        path: "/",
+        query: { "delete" => "" },
+        headers: { "Content-Type" => "application/xml", "Content-MD5" => content_md5 },
+        body: body,
+      )
+    end
+
+    def host
+      client.host_for(name)
+    end
+
+    def path_for(key)
+      "/#{client.escape_key(key)}"
+    end
+
+    private
+
+    def format_range(range)
+      first = range.begin
+      last = range.exclude_end? ? range.end - 1 : range.end
+      "bytes=#{first}-#{last}"
+    end
+
+    def parse_list_response(res)
+      doc = REXML::Document.new(res.body)
+      root = doc.root
+      keys = root.get_elements("Contents/Key").map(&:text)
+      truncated = root.elements["IsTruncated"]&.text == "true"
+      next_token = root.elements["NextContinuationToken"]&.text
+
+      {
+        keys: keys,
+        is_truncated: truncated,
+        next_continuation_token: next_token,
+        raw: res,
+      }
+    end
+
+    def build_delete_payload(keys, quiet)
+      doc = REXML::Document.new
+      doc.add_element("Delete").tap do |delete|
+        delete.add_element("Quiet").text = quiet ? "true" : "false"
+        keys.each do |key|
+          obj = delete.add_element("Object")
+          obj.add_element("Key").text = key
+        end
+      end
+      out = +""
+      doc.write(out)
+      out
+    end
+  end
+end

data/lib/tos/client.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "rexml/document"
+
+module TOS
+  # Low-level HTTP client. Holds credentials, region, endpoint resolution, and
+  # signs every request via TOS::Signer.
+  #
+  # Endpoints follow the pattern `tos-{region}.volces.com` by default; pass
+  # `endpoint:` to override (e.g. for a private endpoint or a custom domain).
+  # When a `bucket` is supplied per-call, it is prepended as a sub-domain:
+  # `https://{bucket}.{endpoint}/{key}`.
+  class Client
+    DEFAULT_OPEN_TIMEOUT = 10
+    DEFAULT_READ_TIMEOUT = 120
+
+    attr_reader :region, :endpoint, :signer
+
+    def initialize(access_key_id:, secret_access_key:, region:, endpoint: nil,
+                   security_token: nil, open_timeout: DEFAULT_OPEN_TIMEOUT,
+                   read_timeout: DEFAULT_READ_TIMEOUT, logger: nil)
+      @region = region.to_s
+      @endpoint = (endpoint || "tos-#{@region}.volces.com").sub(%r{^https?://}, "")
+      @signer = Signer.new(
+        credentials: Credentials.new(
+          access_key_id: access_key_id,
+          secret_access_key: secret_access_key,
+          security_token: security_token
+        ),
+        region: @region
+      )
+      @open_timeout = open_timeout
+      @read_timeout = read_timeout
+      @logger = logger
+    end
+
+    def bucket(name)
+      Bucket.new(client: self, name: name)
+    end
+
+    # Performs a signed request. `headers` is the caller's view of the
+    # request — Authorization/X-Tos-Date/etc. are added automatically.
+    def request(method:, host:, path:, query: {}, headers: {}, body: nil, stream: nil)
+      uri = URI("https://#{host}#{path}")
+      uri.query = signer.send(:encode_query, query) unless query.empty?
+
+      req = build_request(method, uri, body)
+      headers.each { |k, v| req[k] = v }
+      req["Host"] = host
+      req["Content-Length"] = body ? body.bytesize.to_s : "0"
+
+      signed = signer.sign_headers(
+        method: method, path: path, query: query,
+        headers: headers, body: body
+      )
+      signed.each { |k, v| req[k] = v }
+      # Signer-only headers that aren't in the user's `headers` hash.
+      %w[Authorization X-Tos-Date X-Tos-Content-Sha256 X-Tos-Security-Token].each do |k|
+        req[k] = signed[k] if signed[k]
+      end
+
+      do_request(uri, req, stream: stream)
+    end
+
+    def presign(method:, bucket:, key:, query: {}, expires_in: 3600)
+      host = "#{bucket}.#{@endpoint}"
+      path = "/#{escape_key(key)}"
+      signer.presign(method: method, host: host, path: path, query: query, expires_in: expires_in)
+    end
+
+    def host_for(bucket)
+      "#{bucket}.#{@endpoint}"
+    end
+
+    def escape_key(key)
+      signer.send(:encode_path, "/#{key}").sub(%r{^/}, "")
+    end
+
+    private
+
+    def build_request(method, uri, body)
+      klass = case method.to_s.upcase
+              when "GET"    then Net::HTTP::Get
+              when "PUT"    then Net::HTTP::Put
+              when "POST"   then Net::HTTP::Post
+              when "DELETE" then Net::HTTP::Delete
+              when "HEAD"   then Net::HTTP::Head
+              else raise ArgumentError, "unsupported HTTP method: #{method}"
+              end
+      req = klass.new(uri.request_uri)
+      req.body = body if body
+      req
+    end
+
+    def do_request(uri, req, stream:)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = @open_timeout
+      http.read_timeout = @read_timeout
+
+      @logger&.info("[TOS] #{req.method} #{uri}")
+
+      if stream
+        body_chunks = []
+        res = http.request(req) do |response|
+          response.read_body do |chunk|
+            stream.call(chunk)
+            body_chunks << chunk if response.code.to_i >= 400
+          end
+        end
+        validate!(res, body_chunks.join)
+        Response.new(status: res.code.to_i, headers: header_hash(res), body: nil)
+      else
+        res = http.request(req)
+        validate!(res, res.body.to_s)
+        Response.new(status: res.code.to_i, headers: header_hash(res), body: res.body.to_s)
+      end
+    rescue Net::OpenTimeout, Net::ReadTimeout, SocketError, Errno::ECONNREFUSED => e
+      raise NetworkError, "TOS network error: #{e.class}: #{e.message}"
+    end
+
+    def validate!(res, body)
+      code = res.code.to_i
+      return if code.between?(200, 299)
+
+      message, error_code, request_id = parse_error(body, res)
+      raise ServerError.new(
+        "TOS API error (#{code}): #{message}",
+        status: code, code: error_code, request_id: request_id, body: body
+      )
+    end
+
+    def parse_error(body, res)
+      request_id = res["x-tos-request-id"]
+      return [body, nil, request_id] if body.empty?
+
+      doc = REXML::Document.new(body)
+      code = doc.root&.elements&.[]("Code")&.text
+      message = doc.root&.elements&.[]("Message")&.text || body
+      request_id ||= doc.root&.elements&.[]("RequestId")&.text
+      [message, code, request_id]
+    rescue REXML::ParseException
+      [body, nil, request_id]
+    end
+
+    def header_hash(res)
+      {}.tap do |h|
+        res.each_header { |k, v| h[k] = v }
+      end
+    end
+  end
+end

data/lib/tos/credentials.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TOS
+  # Static credentials. STS sessions can be supplied via `security_token`.
+  Credentials = Struct.new(:access_key_id, :secret_access_key, :security_token, keyword_init: true) do
+    def self.from(value)
+      case value
+      when Credentials then value
+      when Hash then new(**value.transform_keys(&:to_sym))
+      else raise ConfigError, "credentials must be a TOS::Credentials or Hash"
+      end
+    end
+
+    def valid?
+      access_key_id.to_s.length.positive? && secret_access_key.to_s.length.positive?
+    end
+  end
+end

data/lib/tos/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module TOS
+  class Error < StandardError
+    attr_reader :status, :code, :request_id, :body
+
+    def initialize(message, status: nil, code: nil, request_id: nil, body: nil)
+      super(message)
+      @status = status
+      @code = code
+      @request_id = request_id
+      @body = body
+    end
+  end
+
+  # Raised when configuration is missing/invalid (no network call attempted).
+  class ConfigError < Error; end
+
+  # Raised when the network call fails before reaching TOS.
+  class NetworkError < Error; end
+
+  # Raised on HTTP 4xx/5xx responses from TOS.
+  class ServerError < Error; end
+end

data/lib/tos/response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module TOS
+  # Lightweight wrapper around a Net::HTTPResponse so callers don't have to
+  # know which HTTP library produced it.
+  class Response
+    attr_reader :status, :headers, :body
+
+    def initialize(status:, headers:, body:)
+      @status = status
+      @headers = headers
+      @body = body
+    end
+
+    def header(name)
+      key = headers.keys.find { |k| k.downcase == name.downcase }
+      key && headers[key]
+    end
+
+    def request_id
+      header("x-tos-request-id") || header("x-tos-id-2")
+    end
+
+    def etag
+      header("etag")&.delete('"')
+    end
+
+    def content_length
+      header("content-length")&.to_i
+    end
+
+    def content_type
+      header("content-type")
+    end
+  end
+end

data/lib/tos/signer.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require "openssl"
+require "time"
+require "uri"
+require "cgi"
+
+module TOS
+  # Signs HTTP requests for the TOS object service using the
+  # TOS4-HMAC-SHA256 scheme (analogous to AWS SigV4, but with the "tos"
+  # service name and a slightly different signed-header policy: by default
+  # only `content-type` and any `x-tos-*` headers are signed).
+  #
+  # Reference: https://github.com/volcengine/ve-tos-golang-sdk/blob/master/tos/sign_v4.go
+  class Signer
+    ALGORITHM = "TOS4-HMAC-SHA256"
+    SERVICE = "tos"
+    REQUEST = "request"
+    EMPTY_SHA256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+    UNSIGNED_PAYLOAD = "UNSIGNED-PAYLOAD"
+
+    attr_reader :credentials, :region
+
+    def initialize(credentials:, region:)
+      @credentials = Credentials.from(credentials)
+      raise ConfigError, "TOS credentials are missing access_key_id/secret_access_key" unless @credentials.valid?
+      raise ConfigError, "TOS region is required" if region.to_s.empty?
+
+      @region = region.to_s
+    end
+
+    # Sign a request and return a Hash of headers to add (Authorization,
+    # X-Tos-Date, X-Tos-Content-Sha256, plus X-Tos-Security-Token when STS
+    # credentials are used).
+    #
+    # @param method [String] HTTP method, uppercased (e.g. "PUT")
+    # @param path [String] URI path starting with "/" (e.g. "/bucket/key")
+    # @param query [Hash{String=>String,Array<String>}] query params
+    # @param headers [Hash] existing request headers (case-insensitive keys)
+    # @param body [String, nil] request body — may be nil for GET/HEAD/DELETE
+    # @param now [Time] override for testing
+    def sign_headers(method:, path:, query: {}, headers: {}, body: nil, now: Time.now.utc)
+      datetime = now.strftime("%Y%m%dT%H%M%SZ")
+      date = datetime[0, 8]
+      content_sha = body ? sha256_hex(body) : EMPTY_SHA256
+
+      working_headers = headers.dup
+      working_headers["X-Tos-Date"] = datetime
+      working_headers["X-Tos-Content-Sha256"] = content_sha
+      working_headers["X-Tos-Security-Token"] = @credentials.security_token if @credentials.security_token
+
+      signed_headers = filter_signed_headers(working_headers)
+
+      canonical_request = build_canonical_request(
+        method: method.to_s.upcase,
+        path: path,
+        query: query,
+        signed_headers: signed_headers,
+        content_sha: content_sha
+      )
+
+      credential_scope = "#{date}/#{@region}/#{SERVICE}/#{REQUEST}"
+      string_to_sign = [ALGORITHM, datetime, credential_scope, sha256_hex(canonical_request)].join("\n")
+
+      signing_key = derive_signing_key(date)
+      signature = hmac_hex(signing_key, string_to_sign)
+
+      authorization = build_authorization_header(signed_headers, credential_scope, signature)
+      working_headers["Authorization"] = authorization
+
+      working_headers
+    end
+
+    # Build a presigned URL with all signing material in the query string.
+    # Returns a fully-qualified URL.
+    def presign(method:, host:, path:, query: {}, expires_in: 3600, now: Time.now.utc)
+      datetime = now.strftime("%Y%m%dT%H%M%SZ")
+      date = datetime[0, 8]
+      credential_scope = "#{date}/#{@region}/#{SERVICE}/#{REQUEST}"
+
+      query_with_sig = query.dup
+      query_with_sig["X-Tos-Algorithm"] = ALGORITHM
+      query_with_sig["X-Tos-Credential"] = "#{@credentials.access_key_id}/#{credential_scope}"
+      query_with_sig["X-Tos-Date"] = datetime
+      query_with_sig["X-Tos-Expires"] = expires_in.to_s
+      query_with_sig["X-Tos-SignedHeaders"] = ""
+      query_with_sig["X-Tos-Security-Token"] = @credentials.security_token if @credentials.security_token
+
+      canonical_request = build_canonical_request(
+        method: method.to_s.upcase,
+        path: path,
+        query: query_with_sig,
+        signed_headers: [],
+        content_sha: UNSIGNED_PAYLOAD
+      )
+
+      string_to_sign = [ALGORITHM, datetime, credential_scope, sha256_hex(canonical_request)].join("\n")
+      signing_key = derive_signing_key(date)
+      query_with_sig["X-Tos-Signature"] = hmac_hex(signing_key, string_to_sign)
+
+      "https://#{host}#{path}?#{encode_query(query_with_sig)}"
+    end
+
+    private
+
+    # Default policy mirrors the Go SDK: only `content-type` (lower-case) and
+    # any `x-tos-*` header is signed. `host` is intentionally NOT signed.
+    def filter_signed_headers(headers)
+      headers.each_with_object([]) do |(name, value), acc|
+        key = name.to_s.downcase
+        next unless key == "content-type" || key.start_with?("x-tos-")
+
+        acc << [key, normalize_value(value)]
+      end.sort_by(&:first)
+    end
+
+    def build_canonical_request(method:, path:, query:, signed_headers:, content_sha:)
+      canonical_headers = signed_headers.map { |k, v| "#{k}:#{v}\n" }.join
+      header_list = signed_headers.map(&:first).join(";")
+
+      [
+        method,
+        encode_path(path),
+        encode_query(query),
+        canonical_headers,
+        header_list,
+        content_sha
+      ].join("\n")
+    end
+
+    def build_authorization_header(signed_headers, credential_scope, signature)
+      header_list = signed_headers.map(&:first).join(";")
+      "#{ALGORITHM} Credential=#{@credentials.access_key_id}/#{credential_scope}," \
+        "SignedHeaders=#{header_list},Signature=#{signature}"
+    end
+
+    def derive_signing_key(date)
+      k_date = hmac(@credentials.secret_access_key, date)
+      k_region = hmac(k_date, @region)
+      k_service = hmac(k_region, SERVICE)
+      hmac(k_service, REQUEST)
+    end
+
+    def normalize_value(value)
+      Array(value).map { |v| v.to_s.split(/\s+/).join(" ") }.join(",")
+    end
+
+    # RFC 3986 percent-encoding for the URI path. Slashes are preserved.
+    def encode_path(path)
+      path.split("/", -1).map { |segment| uri_escape(segment) }.join("/")
+    end
+
+    # Sort by key, then by value, encode and join with `&`.
+    def encode_query(query)
+      pairs = []
+      query.each do |key, values|
+        Array(values).each do |value|
+          pairs << [uri_escape(key.to_s), uri_escape(value.to_s)]
+        end
+      end
+      pairs.sort.map { |k, v| "#{k}=#{v}" }.join("&")
+    end
+
+    def uri_escape(str)
+      # URI.encode_www_form_component encodes space as "+", which is wrong for
+      # SigV4. Use a manual escape that matches Go's url.QueryEscape rules
+      # (which percent-encodes everything except unreserved chars), but preserve
+      # nothing else.
+      str.b.gsub(/([^A-Za-z0-9\-_.~])/) { format("%%%02X", $1.ord) }
+    end
+
+    def sha256_hex(data)
+      OpenSSL::Digest::SHA256.hexdigest(data.to_s)
+    end
+
+    def hmac(key, data)
+      OpenSSL::HMAC.digest("SHA256", key, data)
+    end
+
+    def hmac_hex(key, data)
+      OpenSSL::HMAC.hexdigest("SHA256", key, data)
+    end
+  end
+end

data/lib/tos/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TOS
+  VERSION = "0.1.0"
+end

data/lib/tos.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "openssl"
+
+require_relative "tos/version"
+require_relative "tos/error"
+require_relative "tos/credentials"
+require_relative "tos/signer"
+require_relative "tos/response"
+require_relative "tos/client"
+require_relative "tos/bucket"
+
+# A minimal Ruby SDK for Volcengine TOS (Torch Object Storage).
+#
+#   client = TOS::Client.new(
+#     access_key_id: ENV["TOS_ACCESS_KEY_ID"],
+#     secret_access_key: ENV["TOS_SECRET_ACCESS_KEY"],
+#     region: "cn-beijing"
+#   )
+#   bucket = client.bucket("my-bucket")
+#   bucket.put_object("hello.txt", "world", content_type: "text/plain")
+module TOS
+end

data/ve-tos-ruby-sdk.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "lib/tos/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ve-tos-ruby-sdk"
+  spec.version = TOS::VERSION
+  spec.authors = ["Renny"]
+  spec.summary = "Ruby SDK for Volcengine TOS (Torch Object Storage)"
+  spec.description = "Ruby SDK for Volcengine TOS object storage. " \
+                     "PutObject, GetObject (range), HeadObject, DeleteObject, " \
+                     "DeleteMultipleObjects, ListObjectsV2, and presigned URLs."
+  spec.license = "Apache-2.0"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.files = Dir["lib/**/*.rb", "README.md", "LICENSE", "ve-tos-ruby-sdk.gemspec"]
+  spec.require_paths = ["lib"]
+
+  # rexml is no longer a default gem under Bundler-managed contexts.
+  spec.add_dependency "rexml", ">= 3.2"
+
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "webmock", "~> 3.18"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: ve-tos-ruby-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Renny
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: Ruby SDK for Volcengine TOS object storage. PutObject, GetObject (range),
+  HeadObject, DeleteObject, DeleteMultipleObjects, ListObjectsV2, and presigned URLs.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/tos.rb
+- lib/tos/bucket.rb
+- lib/tos/client.rb
+- lib/tos/credentials.rb
+- lib/tos/error.rb
+- lib/tos/response.rb
+- lib/tos/signer.rb
+- lib/tos/version.rb
+- ve-tos-ruby-sdk.gemspec
+licenses:
+- Apache-2.0
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.11
+specification_version: 4
+summary: Ruby SDK for Volcengine TOS (Torch Object Storage)
+test_files: []