oximg-rails 0.10.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60dbe6811adcd8fe7e15ad740a12fc31495313d001f724cc2dcf06d15332d7cc
+  data.tar.gz: 5ee8b0e337d0dcf4d2cdad614dcfd64abd37a795a5821ee5872136290c90b4c9
+SHA512:
+  metadata.gz: 4a5e41199af0c831458f82eff0957a05e1efccaa478052717116f84b76e70b99388ad2902b8ffe59538fdb92004cba300d5775f227050c4d99ef06cee81d3d70
+  data.tar.gz: 3a4f26a4c18172386bc2b3559039f6eed845e31dbc30180fb6046224ebef7dd830a263af7efa4ec6e375266af8044f9e32f0bc3376a935235f4848d5bb6a07a5

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,100 @@
+# oximg-rails
+
+The Rails-facing half of [oximg](https://github.com/oximg/oximg). The
+split mirrors `imgproxy` / `imgproxy-rails`: the
+[`oximg`](../oximg) gem does local image processing and stays
+framework-free, and everything that points a Rails app at an oximg
+**server** — or wires oximg into ActiveStorage — lives here.
+
+```ruby
+gem "oximg-rails"
+```
+
+## Remote mode: URLs for an oximg server
+
+If you run oximg as a service, the app does not process images at all;
+it emits signed URLs and the server does the work.
+
+```ruby
+Oximg::Server.configure do |config|
+  config.endpoint = "https://img.example.com"
+  config.key      = ENV["OXIMG_KEY"]   # hex, as the server takes it
+  config.salt     = ENV["OXIMG_SALT"]  # hex
+end
+
+Oximg::Server.url_for("photos/a.jpg", width: 750)
+#=> "https://img.example.com/YkUw…/resize/750/0/photos/a.jpg"
+
+Oximg::Server.url_for("photos/a.jpg", width: 750, height: 500, format: :webp)
+#=> ".../resize/750/500/photos/a.jpg@webp"
+```
+
+The source is fitted within the box and never enlarged. A zero axis is
+unconstrained, so `width: 750` alone is exactly what an `srcset` `w`
+descriptor and a Next.js loader mean.
+
+Every setting defaults from the environment, and three of the four
+variables are the ones the server itself reads — so an app deployed
+alongside a configured oximg needs no Ruby-side setup at all:
+
+| Variable | Meaning |
+|---|---|
+| `OXIMG_ENDPOINT` | Root of the deployment. Client-only: the server has no notion of its own public URL. Unset emits root-relative URLs, which is the right answer when oximg is mounted on the app's own origin behind a CDN |
+| `OXIMG_KEY` / `OXIMG_SALT` | Hex HMAC material. Both set means URLs are signed; both unset means they are not; **exactly one set raises** — the same half-configuration the server refuses to boot on |
+| `OXIMG_OPTIONS_PREFIX` | Mount point of the options route, if the server has one |
+
+### The options route
+
+If the server mounts the Cloudflare-Images-compatible route
+(`OXIMG_OPTIONS_PREFIX`), `options_url_for` speaks its grammar — this is
+the route that carries per-request `quality`:
+
+```ruby
+Oximg::Server.options_url_for("photos/a.png", width: 750, quality: 80)
+#=> "https://img.example.com/…/image/width=750,quality=80/photos/a.png"
+```
+
+Options are emitted in a fixed order (`width`, `height`, `quality`,
+`format`). The signature covers the list verbatim, so a stable order is
+also a stable cache key.
+
+### Signing
+
+The scheme is imgproxy's, and it is the server's:
+
+```
+base64url(HMAC-SHA256(key, salt || path))
+```
+
+over the **percent-decoded** path — so one signature covers every URL
+encoding of the same source, and the gem escapes the URL after signing
+it. The signature covers the format token too: a URL for `photo.jpg`
+does not authorize `photo.jpg@avif` and its heavier encode.
+
+`test/server_signer_test.rb` pins this against the exact vectors the
+Rust integration suite serves 200s for. A scheme with two
+implementations is kept honest by shared vectors, not by two readings of
+the same paragraph.
+
+## Local mode: ActiveStorage
+
+**Not implemented yet.** Planned, on top of the `oximg` gem:
+
+- **A variant processor.** `config.active_storage.variant_processor`
+  resolves `ImageProcessing::<Name>`, so an `ImageProcessing::Oximg`
+  backend can plug in beside `:vips` and `:mini_magick` without a
+  monkeypatch — and a Rails app can drop libvips/ImageMagick entirely.
+- **Attachment URL helpers** — `oximg_url` on an attachment, resolving a
+  blob's key into an oximg source path, so remote mode needs no manual
+  path plumbing.
+
+Until then, `Oximg.resize` from the `oximg` gem works fine inside a job.
+
+## Versioning
+
+The gem version tracks the oximg release whose URL grammar it speaks,
+the same convention as the `oximg` gem and the npm package.
+
+## License
+
+Apache-2.0, same as oximg. See [LICENSE](LICENSE).

data/lib/oximg/rails/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Oximg
+  # Note for anything added here later: inside this namespace, a bare
+  # `Rails` resolves to *this* module, not the framework. Always write
+  # `::Rails` for the framework.
+  module Rails
+    # Tracks the oximg release whose URL grammar the client speaks, the
+    # same convention as the oximg gem and the npm package.
+    VERSION = "0.10.1"
+  end
+end

data/lib/oximg/rails.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "oximg"
+require_relative "rails/version"
+require_relative "server"
+
+module Oximg
+  # Rails integration for oximg, split from the `oximg` gem the way
+  # `imgproxy-rails` is split from `imgproxy`: the base gem stays
+  # framework-free, and everything that reaches into Rails lives here.
+  #
+  # What is here today is the server-URL builder (Oximg::Server), which
+  # this gem owns. The ActiveStorage glue — an `ImageProcessing::Oximg`
+  # variant processor for local processing, and attachment URL helpers
+  # for the remote mode — is not implemented yet; see the README.
+  #
+  # Note for anything added here: inside this namespace a bare `Rails`
+  # resolves to *this* module, not the framework. Always write
+  # `::Rails`.
+  module Rails
+  end
+end

data/lib/oximg/server/config.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Oximg
+  module Server
+    # The client-side half of an oximg deployment's configuration: where
+    # the server is, and the signing material it was started with. What
+    # the server *does* with a request (quality profiles, source origin,
+    # memory caps) is server-side config and is deliberately not restated
+    # here — a knob duplicated on both sides is a knob that drifts.
+    #
+    # The defaults read the same environment variables the server itself
+    # reads (+OXIMG_KEY+, +OXIMG_SALT+, +OXIMG_OPTIONS_PREFIX+), so an app
+    # deployed alongside a configured oximg needs no Ruby-side setup at
+    # all. +OXIMG_ENDPOINT+ is client-only: the server has no notion of
+    # its own public URL.
+    class Config
+      # Root of the oximg deployment, without a trailing slash
+      # (+https://img.example.com+). Leave it +nil+ to emit root-relative
+      # URLs — the right answer when oximg is mounted on the app's own
+      # origin behind a CDN.
+      attr_reader :endpoint
+
+      # Hex +OXIMG_KEY+/+OXIMG_SALT+, decoded to bytes. Both nil means
+      # signing is off; exactly one set is a configuration error, checked
+      # at URL-build time (the server refuses to boot on the same
+      # half-configuration rather than serving unsigned).
+      attr_reader :key, :salt
+
+      # Mount point of the Cloudflare-Images-style options route, matching
+      # the server's +OXIMG_OPTIONS_PREFIX+ (e.g. +/image+). Nil means the
+      # route is not mounted and #options_url_for is unavailable.
+      attr_reader :options_prefix
+
+      def initialize(env: ENV)
+        self.endpoint = env["OXIMG_ENDPOINT"]
+        self.key = env["OXIMG_KEY"]
+        self.salt = env["OXIMG_SALT"]
+        self.options_prefix = env["OXIMG_OPTIONS_PREFIX"]
+      end
+
+      def endpoint=(value)
+        @endpoint = blank?(value) ? nil : value.to_s.sub(%r{/+\z}, "")
+      end
+
+      def key=(value)
+        @key = decode_hex("key", value)
+      end
+
+      def salt=(value)
+        @salt = decode_hex("salt", value)
+      end
+
+      def options_prefix=(value)
+        if blank?(value)
+          @options_prefix = nil
+          return
+        end
+        prefix = value.to_s.sub(%r{/+\z}, "")
+        prefix = "/#{prefix}" unless prefix.start_with?("/")
+        @options_prefix = prefix
+      end
+
+      # True when URLs will carry a signature.
+      def signing?
+        !@key.nil? && !@salt.nil?
+      end
+
+      # Fail closed the way the server does: a half-configured signing
+      # pair must never quietly produce unsigned URLs that the server will
+      # answer with 403.
+      def validate!
+        return if @key.nil? == @salt.nil?
+
+        raise ConfigurationError,
+          "key and salt must both be set to enable signing (got only #{@key.nil? ? "salt" : "key"})"
+      end
+
+      private
+
+      def blank?(value)
+        value.nil? || value.to_s.strip.empty?
+      end
+
+      def decode_hex(name, value)
+        return nil if blank?(value)
+
+        hex = value.to_s.strip
+        unless hex.match?(/\A(?:[0-9a-fA-F]{2})+\z/)
+          raise ConfigurationError, "#{name} is not valid hex (even-length 0-9a-f)"
+        end
+
+        [hex].pack("H*")
+      end
+    end
+  end
+end

data/lib/oximg/server/signer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "openssl"
+
+module Oximg
+  module Server
+    # The imgproxy-style signing scheme, exactly as the server verifies it
+    # (+Signing::verify+ in src/main.rs): the signature is
+    # +base64url(HMAC-SHA256(key, salt || path))+ over the percent-DECODED
+    # path, so one signature covers every URL encoding of the same source.
+    #
+    # test/server_signer_test.rb pins this against the vectors the Rust
+    # integration suite serves 200s for — a scheme with two
+    # implementations needs shared vectors, not two readings of the prose.
+    module Signer
+      module_function
+
+      # +path+ is the decoded path the server reconstructs before
+      # verifying: "/resize/{w}/{h}/{file}" on the positional route,
+      # "{prefix}/{options}/{file}" on the options route.
+      def sign(key, salt, path)
+        # Force binary before concatenating: key material is arbitrary
+        # bytes, and a non-ASCII filename in a UTF-8 path would otherwise
+        # raise Encoding::CompatibilityError on the join.
+        digest = OpenSSL::HMAC.digest("SHA256", key, salt + path.to_s.b)
+        # Unpadded base64url. The server strips "=" before decoding, so
+        # padding would verify too — but every vector it ships is
+        # unpadded, and an unpadded signature is one path segment with no
+        # escaping question.
+        [digest].pack("m0").tr("+/", "-_").delete("=")
+      end
+    end
+  end
+end

data/lib/oximg/server/url_builder.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Oximg
+  module Server
+    # Builds URLs for the two routes an oximg server mounts. Nothing here
+    # talks to the server: a URL is pure arithmetic over the config, so a
+    # Rails view can emit thousands of them without leaving the process.
+    #
+    # Validation mirrors the server's own bounds and fails closed on the
+    # same inputs. That is not defence — the server validates regardless —
+    # it is so a typo surfaces at the call site with a name, instead of as
+    # a 400 in an <img> tag nobody is watching.
+    class UrlBuilder
+      # The server's cap on either axis (src/main.rs); 0 means
+      # "unconstrained" on the positional route only.
+      MAX_DIMENSION = 8192
+
+      # Tokens the positional route's @fmt suffix accepts. "jxl" is
+      # reserved by the server for a future encoder and answers 400, so it
+      # is not offered here.
+      FORMATS = %w[jpg jpeg png webp avif].freeze
+
+      # The options route additionally understands format=auto, which
+      # means "negotiate, else the source's own format".
+      OPTION_FORMATS = (FORMATS + %w[auto]).freeze
+
+      # Everything outside RFC 3986's unreserved set gets percent-encoded.
+      # "/" stays literal so S3-style prefixes remain readable, and "@" so
+      # the format token survives; both are legal in a path segment, and
+      # the server signs the decoded form either way.
+      UNSAFE = %r{[^A-Za-z0-9\-._~/@]}
+
+      def initialize(config)
+        @config = config
+      end
+
+      # The positional route: +/resize/{w}/{h}/{file}+, where the source
+      # is fitted within the box and never enlarged. A zero axis is
+      # unconstrained — <tt>width: 750</tt> alone is exactly what an
+      # +srcset+ +w+ descriptor means.
+      #
+      #   builder.resize("photos/a.jpg", width: 750)
+      #   builder.resize("photos/a.jpg", width: 750, height: 500, format: :webp)
+      def resize(source, width: 0, height: 0, format: nil)
+        w = dimension(width, "width")
+        h = dimension(height, "height")
+        if w.zero? && h.zero?
+          raise ArgumentError, "at least one of width/height must be non-zero"
+        end
+
+        file = source_path(source)
+        file = "#{file}@#{token(format, FORMATS, "format")}" unless format.nil?
+        build("/resize/#{w}/#{h}/", file)
+      end
+
+      # The Cloudflare-Images-compatible options route,
+      # +{prefix}/width=750,quality=80/{file}+. Requires the server to
+      # have +OXIMG_OPTIONS_PREFIX+ set and the same prefix configured
+      # here. Options are emitted in a fixed order: the signature covers
+      # the list verbatim, so a stable order is also a stable cache key.
+      def options(source, width: nil, height: nil, quality: nil, format: nil)
+        prefix = @config.options_prefix
+        unless prefix
+          raise ConfigurationError,
+            "options_prefix is not configured (set it to the server's OXIMG_OPTIONS_PREFIX)"
+        end
+
+        build("#{prefix}/#{option_list(width, height, quality, format)}/", source_path(source))
+      end
+
+      private
+
+      # +prefix+ is generated, ASCII-safe and already signed-form; only
+      # the caller's source path needs escaping. The signature is computed
+      # over the decoded path and prepended as its own segment, which is
+      # what puts it before the options route's prefix rather than after.
+      def build(prefix, file)
+        @config.validate!
+        url = +""
+        url << @config.endpoint if @config.endpoint
+        if @config.signing?
+          url << "/" << Signer.sign(@config.key, @config.salt, "#{prefix}#{file}")
+        end
+        url << prefix << escape(file)
+        url.freeze
+      end
+
+      def escape(path)
+        path.gsub(UNSAFE) { |c| c.unpack("C*").map { |b| format("%%%02X", b) }.join }
+      end
+
+      def source_path(source)
+        path = source.to_s.sub(%r{\A/+}, "")
+        raise ArgumentError, "source path is empty" if path.empty?
+
+        # "." and ".." would make the signed path and the path the server
+        # resolves two different things; the server refuses them anyway.
+        if path.split("/").any? { |segment| segment == "." || segment == ".." }
+          raise ArgumentError, "source path must not contain \".\" or \"..\" segments: #{source.inspect}"
+        end
+
+        path
+      end
+
+      def dimension(value, name)
+        unless value.is_a?(Integer) && value >= 0 && value <= MAX_DIMENSION
+          raise ArgumentError, "#{name} must be an Integer in 0..#{MAX_DIMENSION}, got #{value.inspect}"
+        end
+
+        value
+      end
+
+      def option_list(width, height, quality, format)
+        if width.nil? && height.nil?
+          raise ArgumentError, "at least one of width/height is required on the options route"
+        end
+
+        parts = []
+        parts << "width=#{bounded(width, "width", 1, MAX_DIMENSION)}" unless width.nil?
+        parts << "height=#{bounded(height, "height", 1, MAX_DIMENSION)}" unless height.nil?
+        parts << "quality=#{bounded(quality, "quality", 1, 100)}" unless quality.nil?
+        parts << "format=#{token(format, OPTION_FORMATS, "format")}" unless format.nil?
+        parts.join(",")
+      end
+
+      def bounded(value, name, min, max)
+        unless value.is_a?(Integer) && value >= min && value <= max
+          raise ArgumentError, "#{name} must be an Integer in #{min}..#{max}, got #{value.inspect}"
+        end
+
+        value
+      end
+
+      def token(value, allowed, name)
+        token = value.to_s.downcase
+        unless allowed.include?(token)
+          raise ArgumentError, "unknown #{name} #{value.inspect} (#{allowed.join("|")})"
+        end
+
+        token
+      end
+    end
+  end
+end

data/lib/oximg/server.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "oximg"
+
+require_relative "server/config"
+require_relative "server/signer"
+require_relative "server/url_builder"
+
+module Oximg
+  # The remote half of oximg: building — and HMAC-signing — URLs for an
+  # oximg **server**, for deployments that let the server do the work
+  # instead of processing locally with +Oximg.resize+.
+  #
+  #   Oximg::Server.configure do |config|
+  #     config.endpoint = "https://img.example.com"
+  #     config.key      = ENV["OXIMG_KEY"]
+  #     config.salt     = ENV["OXIMG_SALT"]
+  #   end
+  #
+  #   Oximg::Server.url_for("photos/a.jpg", width: 750)
+  #   #=> "https://img.example.com/{sig}/resize/750/0/photos/a.jpg"
+  #
+  # Nothing here talks to the server: a URL is arithmetic over the
+  # config, so a view can emit thousands of them without leaving the
+  # process.
+  module Server
+    # Raised for a configuration that cannot produce a URL the server
+    # would accept — a half-set signing pair, or the options route used
+    # without its prefix.
+    class ConfigurationError < Oximg::Error; end
+
+    class << self
+      # The process-wide configuration, seeded from the environment
+      # (see Config). Set it up once at boot; it is read, not written,
+      # per URL.
+      def config
+        @config ||= Config.new
+      end
+
+      attr_writer :config
+
+      def configure
+        yield config
+        config
+      end
+
+      # Drops the configuration back to the environment defaults.
+      # Exists for tests — an app should configure once at boot.
+      def reset!
+        @config = Config.new
+      end
+
+      # The positional route: see UrlBuilder#resize.
+      def url_for(source, **options)
+        UrlBuilder.new(config).resize(source, **options)
+      end
+
+      # The Cloudflare-Images-style options route: see
+      # UrlBuilder#options.
+      def options_url_for(source, **options)
+        UrlBuilder.new(config).options(source, **options)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: oximg-rails
+version: !ruby/object:Gem::Version
+  version: 0.10.1
+platform: ruby
+authors:
+- oximg contributors
+bindir: bin
+cert_chain: []
+date: 2026-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oximg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: 'The Rails-facing half of oximg: builds and HMAC-signs URLs for a remote
+  oximg server, for apps that let the server do the work instead of processing locally
+  with the `oximg` gem. ActiveStorage glue is in progress.'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/oximg/rails.rb
+- lib/oximg/rails/version.rb
+- lib/oximg/server.rb
+- lib/oximg/server/config.rb
+- lib/oximg/server/signer.rb
+- lib/oximg/server/url_builder.rb
+homepage: https://github.com/oximg/oximg
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/oximg/oximg
+  source_code_uri: https://github.com/oximg/oximg/tree/main/rubygem/oximg-rails
+  changelog_uri: https://github.com/oximg/oximg/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/oximg/oximg/issues
+  documentation_uri: https://github.com/oximg/oximg/blob/main/rubygem/oximg-rails/README.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Rails integration for oximg, and URL building for a remote oximg server
+test_files: []