Add custom services (#188)

* feature: Add custom services

Signed-off-by: Valentin Kiselev <mrexox@evilmartians.com>

* fix: Use separate config for services

Signed-off-by: Valentin Kiselev <mrexox@evilmartians.com>

* chore: Update README with custom services info

Signed-off-by: Valentin Kiselev <mrexox@evilmartians.com>

* chore: Dry Imgproxy::Config - move attributes to :default service

Signed-off-by: Valentin Kiselev <mrexox@evilmartians.com>

* chore: Drop comments on moved attributes

Signed-off-by: Valentin Kiselev <mrexox@evilmartians.com>

* chore: Add getters for old options and dry builder a bit

Signed-off-by: Valentin Kiselev <mrexox@evilmartians.com>

Author: mrexox

README.md

@@ -381,6 +381,34 @@ end
 
 **NOTE:** imgproxy.rb provides built-in adapters for Active Storage and Shrine that are automatically added when Active Storage or Shrine support is enabled.
 
+## Custom services
+
+If you use more than one instance of imgproxy and they have different endpoints and key/salt configurations you can specify them in `services` option.
+
+```ruby
+Imgproxy.configure do |config|
+  config.endpoint = "https://main.imgproxy.com/"
+  config.service(:pro) do |pro|
+    pro.endpoint = "https://pro.imgproxy.com/"
+    pro.key = ENV["IMGPROXY_PRO_KEY"]
+    pro.salt = ENV["IMGPROXY_PRO_SALT"]
+  end
+end
+```
+
+Or via YAML config:
+
+```yaml
+endpoint: "https://main.imgproxy.com/"
+services:
+  pro:
+    endpoint: "https://pro.imgproxy.com/"
+    key: <%= ENV["IMGPROXY_PRO_KEY"] %>
+    salt: <%= ENV["IMGPROXY_PRO_SALT"] %>
+```
+
+If you don't specify `key`, `salt`, `endpoint`, or `signature_size`, they are inherited from the global configuration.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/imgproxy/imgproxy.rb.

lib/imgproxy/builder.rb

@@ -18,6 +18,8 @@ module Imgproxy
   #   builder.url_for("http://images.example.com/images/image1.jpg")
   #   builder.url_for("http://images.example.com/images/image2.jpg")
   class Builder
+    class UnknownServiceError < StandardError; end
+
     # @param [Hash] options Processing options
     # @see Imgproxy.url_for
     def initialize(options = {})
@@ -39,7 +41,7 @@ def url_for(image)
       path = [*processing_options, url(image, ext: @format)].join("/")
       signature = sign_path(path)
 
-      File.join(Imgproxy.config.endpoint.to_s, signature, path)
+      File.join(endpoint.to_s, signature, path)
     end
 
     # Genrates imgproxy info URL
@@ -52,14 +54,18 @@ def info_url_for(image)
       path = url(image)
       signature = sign_path(path)
 
-      File.join(Imgproxy.config.endpoint.to_s, "info", signature, path)
+      File.join(endpoint.to_s, "info", signature, path)
     end
 
     private
 
+    attr_reader :service
+
     NEED_ESCAPE_RE = /[@?% ]|[^\p{Ascii}]/.freeze
 
     def extract_builder_options(options)
+      @service = options.delete(:service)&.to_sym || :default
+
       @use_short_options = not_nil_or(options.delete(:use_short_options), config.use_short_options)
       @base64_encode_url = not_nil_or(options.delete(:base64_encode_url), config.base64_encode_urls)
       @escape_plain_url =
@@ -118,23 +124,33 @@ def ready_to_sign?
     end
 
     def signature_key
-      config.raw_key
+      service_config.raw_key
     end
 
     def signature_salt
-      config.raw_salt
+      service_config.raw_salt
     end
 
     def signature_size
-      config.signature_size
-    end
-
-    def config
-      Imgproxy.config
+      service_config.signature_size
     end
 
     def not_nil_or(value, fallback)
       value.nil? ? fallback : value
     end
+
+    def endpoint
+      service_config.endpoint
+    end
+
+    def service_config
+      @service_config ||= config.services[service].tap do |c|
+        raise UnknownServiceError, service unless c
+      end
+    end
+
+    def config
+      Imgproxy.config
+    end
   end
 end

lib/imgproxy/config.rb

@@ -1,28 +1,11 @@
 require "anyway_config"
 
+require "imgproxy/service_config"
 require "imgproxy/url_adapters"
 
 module Imgproxy
   # Imgproxy config
   #
-  # @!attribute endpoint
-  #   imgproxy endpoint
-  #   @return [String]
-  # @!attribute key
-  #   imgproxy hex-encoded signature key
-  #   @return [String]
-  # @!attribute salt
-  #   imgproxy hex-encoded signature salt
-  #   @return [String]
-  # @!attribute raw_key
-  #   Decoded signature key
-  #   @return [String]
-  # @!attribute raw_salt
-  #   Decoded signature salt
-  #   @return [String]
-  # @!attribute signature_size
-  #   imgproxy signature size. Defaults to 32
-  #   @return [String]
   # @!attribute use_short_options
   #   Use short processing option names (+rs+ for +resize+, +g+ for +gravity+, etc).
   #   Defaults to true
@@ -50,49 +33,81 @@ module Imgproxy
   # @see https://github.com/palkan/anyway_config anyway_config
   class Config < Anyway::Config
     attr_config(
-      :endpoint,
-      :key,
-      :salt,
-      :raw_key,
-      :raw_salt,
-      signature_size: 32,
       use_short_options: true,
       base64_encode_urls: false,
       always_escape_plain_urls: false,
       use_s3_urls: false,
       use_gcs_urls: false,
       gcs_bucket: nil,
       shrine_host: nil,
+      services: {},
     )
 
-    alias_method :set_key, :key=
-    alias_method :set_raw_key, :raw_key=
-    alias_method :set_salt, :salt=
-    alias_method :set_raw_salt, :raw_salt=
-    private :set_key, :set_raw_key, :set_salt, :set_raw_salt
+    def endpoint
+      service(:default).endpoint
+    end
+
+    def endpoint=(value)
+      service(:default).endpoint = value
+    end
+
+    def key
+      service(:default).key
+    end
 
     def key=(value)
-      value = value&.to_s
-      super(value)
-      set_raw_key(value && [value].pack("H*"))
+      service(:default).key = value
+    end
+
+    def raw_key
+      service(:default).raw_key
     end
 
     def raw_key=(value)
-      value = value&.to_s
-      super(value)
-      set_key(value&.unpack("H*")&.first)
+      service(:default).raw_key = value
+    end
+
+    def salt
+      service(:default).salt
     end
 
     def salt=(value)
-      value = value&.to_s
-      super(value)
-      set_raw_salt(value && [value].pack("H*"))
+      service(:default).salt = value
+    end
+
+    def raw_salt
+      service(:default).raw_salt
     end
 
     def raw_salt=(value)
-      value = value&.to_s
-      super(value)
-      set_salt(value&.unpack("H*")&.first)
+      service(:default).raw_salt = value
+    end
+
+    def signature_size
+      service(:default).signature_size
+    end
+
+    def signature_size=(value)
+      service(:default).signature_size = value
+    end
+
+    def service(name)
+      services[name.to_sym] ||= ServiceConfig.new(services[:default].to_h)
+      yield services[name.to_sym] if block_given?
+
+      services[name.to_sym]
+    end
+
+    def services
+      @services ||= {}.tap do |s|
+        s[:default] = ServiceConfig.new
+
+        super.each do |name, data|
+          s[name.to_sym] = ServiceConfig.new(
+            s[:default].to_h.merge(data.symbolize_keys),
+          )
+        end
+      end
     end
 
     # @deprecated Please use {#key} instead

lib/imgproxy/service_config.rb

@@ -0,0 +1,69 @@
+require "anyway_config"
+
+module Imgproxy
+  # Imgproxy custom config for services
+  #
+  # @!attribute endpoint
+  #   imgproxy endpoint
+  #   @return [String]
+  # @!attribute key
+  #   imgproxy hex-encoded signature key
+  #   @return [String]
+  # @!attribute salt
+  #   imgproxy hex-encoded signature salt
+  #   @return [String]
+  # @!attribute raw_key
+  #   Decoded signature key
+  #   @return [String]
+  # @!attribute raw_salt
+  #   Decoded signature salt
+  #   @return [String]
+  # @!attribute signature_size
+  #   imgproxy signature size. Defaults to 32
+  #   @return [String]
+  #
+  # @see Imgproxy::Config
+  class ServiceConfig < Anyway::Config
+    # Inherit global config values
+    config_name :imgproxy
+
+    attr_config(
+      :endpoint,
+      :key,
+      :salt,
+      :raw_key,
+      :raw_salt,
+      signature_size: 32,
+    )
+
+    alias_method :set_key, :key=
+    alias_method :set_raw_key, :raw_key=
+    alias_method :set_salt, :salt=
+    alias_method :set_raw_salt, :raw_salt=
+    private :set_key, :set_raw_key, :set_salt, :set_raw_salt
+
+    def key=(value)
+      value = value&.to_s
+      super(value)
+      set_raw_key(value && [value].pack("H*"))
+    end
+
+    def raw_key=(value)
+      value = value&.to_s
+      super(value)
+      set_key(value&.unpack("H*")&.first)
+    end
+
+    def salt=(value)
+      value = value&.to_s
+      super(value)
+      set_raw_salt(value && [value].pack("H*"))
+    end
+
+    def raw_salt=(value)
+      value = value&.to_s
+      super(value)
+      set_salt(value&.unpack("H*")&.first)
+    end
+  end
+end

lib/imgproxy/url_adapters/shrine.rb

@@ -16,7 +16,7 @@ def url(image)
         return s3_url(image) if use_s3_url(image)
 
         opts = {}
-        opts[:host] = Imgproxy.config.shrine_host if Imgproxy.config.shrine_host
+        opts[:host] = config.shrine_host if config.shrine_host
         image.url(**opts)
       end
 
@@ -28,9 +28,13 @@ def s3_url(image)
       end
 
       def use_s3_url(image)
-        Imgproxy.config.use_s3_urls &&
+        config.use_s3_urls &&
           image.storage.is_a?(::Shrine::Storage::S3)
       end
+
+      def config
+        Imgproxy.config
+      end
     end
   end
 end

spec/imgproxy_spec.rb

@@ -656,5 +656,42 @@
         end
       end
     end
+
+    context "when custom service specified" do
+      let(:options) { { width: 100, height: 100 } }
+
+      before do
+        described_class.configure do |config|
+          config.service(:custom) do |custom|
+            custom.key = "Lorem".unpack1("H*")
+            custom.salt = "Ipsum".unpack1("H*")
+            custom.endpoint = "http://custom-imgproxy.test/"
+          end
+        end
+      end
+
+      it "signs the info URL" do
+        expect(described_class.info_url_for(src_url, service: :custom)).to start_with(
+          "http://custom-imgproxy.test/info/Ce7iwcp9c0K7mvJD9pLbwXmQ-r-rkNJ1jLIPr2sCVv8/",
+        )
+      end
+
+      context "when signature is truncated" do
+        before { described_class.config.service(:custom).signature_size = 5 }
+
+        it "signs the info URL with truncated signature" do
+          expect(described_class.info_url_for(src_url, service: :custom)).to start_with(
+            "http://custom-imgproxy.test/info/Ce7iwco/",
+          )
+        end
+      end
+
+      context "when service is unknown" do
+        it "raises UnknownServiceError" do
+          expect { described_class.info_url_for(src_url, service: :unknown) }
+            .to raise_error(Imgproxy::Builder::UnknownServiceError)
+        end
+      end
+    end
   end
 end