imgproxy 2.0.1 → 3.0.0

data/lib/imgproxy/options_casters/watermark_size.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "imgproxy/options_casters/integer"
+require "imgproxy/options_casters/bool"
+require "imgproxy/options_casters/extend"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts `watermark_size` processing option
+    module WatermarkSize
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        [
+          Imgproxy::OptionsCasters::Integer.cast(raw[:width]) || 0,
+          Imgproxy::OptionsCasters::Integer.cast(raw[:height]) || 0,
+        ]
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/{gif_options.rb → webp_options.rb}

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 require "imgproxy/options_casters/group"
-require "imgproxy/options_casters/bool"
+require "imgproxy/options_casters/string"
 
 module Imgproxy
   module OptionsCasters
-    # Casts gif_options option
-    module GifOptions
+    # Casts `webp_options` processing option
+    module WebpOptions
       CASTER = Imgproxy::OptionsCasters::Group.new(
-        optimize_frames: Imgproxy::OptionsCasters::Bool,
-        optimize_transparency: Imgproxy::OptionsCasters::Bool,
+        compression: Imgproxy::OptionsCasters::String,
       ).freeze
 
       def self.cast(raw)

data/lib/imgproxy/options_casters/zoom.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "imgproxy/trim_array"
+require "imgproxy/options_casters/float"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts `zoom` info option
+    module Zoom
+      using TrimArray
+
+      def self.cast(raw)
+        # Allow zoom to be just a float
+        return Imgproxy::OptionsCasters::Float.cast(raw) if raw.is_a?(Numeric)
+
+        return raw unless raw.is_a?(Hash)
+
+        return Imgproxy::OptionsCasters::Float.cast(raw[:zoom_x_y]) if raw.key?(:zoom_x_y)
+
+        [
+          Imgproxy::OptionsCasters::Float.cast(raw[:zoom_x]) || 1,
+          Imgproxy::OptionsCasters::Float.cast(raw[:zoom_y]) || 1,
+        ].trim!
+      end
+    end
+  end
+end

data/lib/imgproxy/service_config.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+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]
+  # @!attribute source_url_encryption_key
+  #   imgproxy hex-encoded source URL encryption key
+  #   @return [String]
+  # @!attribute raw_source_url_encryption_key
+  #   Decoded source URL encryption key
+  #   @return [String]
+  # @!attribute always_encrypt_source_urls
+  #   Always encrypt source URLs. Defaults to false
+  #   @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,
+      :source_url_encryption_key,
+      :raw_source_url_encryption_key,
+      signature_size: 32,
+      always_encrypt_source_urls: false,
+    )
+
+    coerce_types(
+      endpoint: :string,
+      key: :string,
+      salt: :string,
+      raw_key: :string,
+      raw_salt: :string,
+      signature_size: :integer,
+      source_url_encryption_key: :string,
+      raw_source_url_encryption_key: :string,
+      always_encrypt_source_urls: :boolean,
+    )
+
+    alias_method :set_key, :key=
+    alias_method :set_raw_key, :raw_key=
+    alias_method :set_salt, :salt=
+    alias_method :set_raw_salt, :raw_salt=
+    alias_method :set_source_url_encryption_key, :source_url_encryption_key=
+    alias_method :set_raw_source_url_encryption_key, :raw_source_url_encryption_key=
+
+    private :set_key, :set_raw_key, :set_salt, :set_raw_salt,
+      :set_source_url_encryption_key, :set_raw_source_url_encryption_key
+
+    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*"))
+    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&.unpack1("H*"))
+    end
+
+    def source_url_encryption_key=(value)
+      value = value&.to_s
+      super(value)
+      set_raw_source_url_encryption_key(value && [value].pack("H*"))
+    end
+
+    def raw_source_url_encryption_key=(value)
+      value = value&.to_s
+      super(value)
+      set_source_url_encryption_key(value&.unpack1("H*"))
+    end
+  end
+end

data/lib/imgproxy/trim_array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Imgproxy
   # `Array.trim!` refinement
   module TrimArray

data/lib/imgproxy/url_adapters/active_storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Imgproxy
   class UrlAdapters
     # Adapter for ActiveStorage
@@ -24,11 +26,11 @@ module Imgproxy
       private
 
       def s3_url(image)
-        "s3://#{image.service.bucket.name}/#{image.key}"
+        "s3://#{service(image).bucket.name}/#{image.key}"
       end
 
       def use_s3_url(image)
-        config.use_s3_urls && image.service.is_a?(::ActiveStorage::Service::S3Service)
+        config.use_s3_urls && service(image).is_a?(::ActiveStorage::Service::S3Service)
       end
 
       def gcs_url(image)
@@ -36,7 +38,17 @@ module Imgproxy
       end
 
       def use_gcs_url(image)
-        config.use_gcs_urls && image.service.is_a?(::ActiveStorage::Service::GCSService)
+        config.use_gcs_urls && service(image).is_a?(::ActiveStorage::Service::GCSService)
+      end
+
+      def service(image)
+        unwrap_service(image.service)
+      end
+
+      def unwrap_service(service)
+        return service unless defined?(::ActiveStorage::Service::MirrorService)
+        return service unless service.is_a?(::ActiveStorage::Service::MirrorService)
+        unwrap_service(service.primary)
       end
 
       def config

data/lib/imgproxy/url_adapters/shrine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Imgproxy
   class UrlAdapters
     # Adapter for Shrine
@@ -16,8 +18,8 @@ module Imgproxy
         return s3_url(image) if use_s3_url(image)
 
         opts = {}
-        opts[:host] = Imgproxy.config.shrine_host if Imgproxy.config.shrine_host
-        image.url(opts)
+        opts[:host] = config.shrine_host if config.shrine_host
+        image.url(**opts)
       end
 
       private
@@ -28,9 +30,13 @@ module Imgproxy
       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

data/lib/imgproxy/url_adapters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "imgproxy/url_adapters/active_storage"
 require "imgproxy/url_adapters/shrine"
 
@@ -11,6 +13,7 @@ module Imgproxy
   #   Imgproxy.url_for(user.avatar)
   class UrlAdapters
     class NotFound < StandardError; end
+
     class NotConfigured < StandardError; end
 
     # @return [Array] Currently added adapters

data/lib/imgproxy/url_builders/base.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require "openssl"
+require "base64"
+require "erb"
+
+require "imgproxy/options_builders/base"
+
+module Imgproxy
+  module UrlBuilders
+    class UnknownServiceError < StandardError; end
+
+    class InvalidEncryptionKeyError < StandardError; end
+
+    # Builds imgproxy URL
+    #
+    #   builder = Imgproxy::UrlBuilders::Base.new(
+    #     width: 500,
+    #     height: 400,
+    #     resizing_type: :fill,
+    #     sharpen: 0.5
+    #   )
+    #
+    #   builder.url_for("http://images.example.com/images/image1.jpg")
+    #   builder.url_for("http://images.example.com/images/image2.jpg")
+    class Base
+      OPTIONS_BUILDER = OptionsBuilders::Base
+      OPTION_ALIASES = {}.freeze
+
+      # @param [Hash] options imgproxy URL options
+      # @see Imgproxy.url_for
+      # @see Imgproxy.info_url_for
+      def initialize(options = {})
+        options = options.dup
+
+        extract_builder_options(options)
+
+        @options = self.class::OPTIONS_BUILDER.new(options)
+      end
+
+      # Genrates imgproxy URL
+      #
+      # @return [String] imgproxy URL
+      # @param [String,URI, Object] _image Source image URL or object applicable for
+      #   the configured URL adapters
+      # @see Imgproxy.url_for
+      # @see Imgproxy.info_url_for
+      def url_for(_image)
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :service
+
+      NEED_ESCAPE_RE = /[@?% ]|[^\p{Ascii}]/.freeze
+      AES_SIZES = {32 => 256, 24 => 196, 16 => 128}.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 =
+          not_nil_or(options.delete(:escape_plain_url), config.always_escape_plain_urls)
+        @encrypt_source_url =
+          not_nil_or(options.delete(:encrypt_source_url), service_config.always_encrypt_source_urls)
+        @source_url_encryption_iv = options.delete(:source_url_encryption_iv)
+      end
+
+      def option_strings
+        @option_strings ||= @options.map do |key, value|
+          [option_alias(key), value].join(":")
+        end
+      end
+
+      def sourcce_url(image, ext: nil)
+        url = config.url_adapters.url_of(image)
+
+        return encrypted_sourcce_url_for(url, ext: ext) if @encrypt_source_url
+        return base64_sourcce_url_for(url, ext: ext) if @base64_encode_url
+        plain_url_for(url, ext: ext)
+      end
+
+      def plain_url_for(url, ext: nil)
+        escaped_url = need_escape_url?(url) ? ERB::Util.url_encode(url) : url
+
+        ext ? "plain/#{escaped_url}@#{ext}" : "plain/#{escaped_url}"
+      end
+
+      def base64_sourcce_url_for(url, ext: nil)
+        encoded_url = Base64.urlsafe_encode64(url).tr("=", "").scan(/.{1,16}/).join("/")
+
+        ext ? "#{encoded_url}.#{ext}" : encoded_url
+      end
+
+      def encrypted_sourcce_url_for(url, ext: nil)
+        cipher = build_cipher
+
+        iv = @source_url_encryption_iv || cipher.random_iv
+        cipher.iv = iv
+
+        "enc/#{base64_sourcce_url_for(iv + cipher.update(url) + cipher.final, ext: ext)}"
+      end
+
+      def need_escape_url?(url)
+        @escape_plain_url || url.match?(NEED_ESCAPE_RE)
+      end
+
+      def build_cipher
+        key = encryption_key.to_s
+
+        aes_size = AES_SIZES.fetch(key.length) do
+          raise Imgproxy::UrlBuilders::InvalidEncryptionKeyError,
+            "Encryption key should be 16/24/32 bytes long, now - #{key.length}"
+        end
+
+        OpenSSL::Cipher::AES.new(aes_size, :CBC).tap do |cipher|
+          cipher.encrypt
+          cipher.key = key
+        end
+      end
+
+      def option_alias(name)
+        return name unless @use_short_options
+
+        self.class::OPTION_ALIASES.fetch(name, name)
+      end
+
+      def sign_path(path)
+        return "unsafe" unless ready_to_sign?
+
+        digest = OpenSSL::HMAC.digest(
+          OpenSSL::Digest.new("sha256"),
+          signature_key,
+          "#{signature_salt}/#{path}",
+        )[0, signature_size]
+
+        Base64.urlsafe_encode64(digest).tr("=", "")
+      end
+
+      def ready_to_sign?
+        !(signature_key.nil? || signature_salt.nil? ||
+          signature_key.empty? || signature_salt.empty?)
+      end
+
+      def signature_key
+        service_config.raw_key
+      end
+
+      def signature_salt
+        service_config.raw_salt
+      end
+
+      def signature_size
+        service_config.signature_size
+      end
+
+      def encryption_key
+        service_config.raw_source_url_encryption_key
+      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 Imgproxy::UrlBuilders::UnknownServiceError, service unless c
+        end
+      end
+
+      def config
+        Imgproxy.config
+      end
+    end
+  end
+end

data/lib/imgproxy/url_builders/info.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "imgproxy/option_aliases/info"
+require "imgproxy/options_builders/info"
+require "imgproxy/url_builders/base"
+
+module Imgproxy
+  module UrlBuilders
+    # Builds imgproxy info URL
+    #
+    #   builder = Imgproxy::UrlBuilders::Info.new(
+    #     width: 500,
+    #     height: 400,
+    #     resizing_type: :fill,
+    #     sharpen: 0.5
+    #   )
+    #
+    #   builder.url_for("http://images.example.com/images/image1.jpg")
+    #   builder.url_for("http://images.example.com/images/image2.jpg")
+    class Info < Base
+      OPTIONS_BUILDER = OptionsBuilders::Info
+      OPTION_ALIASES = Imgproxy::OptionAliases::INFO
+
+      # @param [Hash] options Info options
+      # @see Imgproxy.info_url_for
+      def initialize(options = {})
+        super
+      end
+
+      # Genrates imgproxy info URL
+      #
+      # @return [String] imgproxy info URL
+      # @param [String,URI, Object] image Source image URL or object applicable for
+      #   the configured URL adapters
+      # @see Imgproxy.info_url_for
+      def url_for(image)
+        path = [*option_strings, sourcce_url(image)].join("/")
+        signature = sign_path(path)
+
+        File.join(endpoint.to_s, "info", signature, path)
+      end
+    end
+  end
+end

data/lib/imgproxy/url_builders/processing.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "imgproxy/option_aliases/processing"
+require "imgproxy/options_builders/processing"
+require "imgproxy/url_builders/base"
+
+module Imgproxy
+  module UrlBuilders
+    # Builds imgproxy URL
+    #
+    #   builder = Imgproxy::UrlBuilders::Processing.new(
+    #     width: 500,
+    #     height: 400,
+    #     resizing_type: :fill,
+    #     sharpen: 0.5
+    #   )
+    #
+    #   builder.url_for("http://images.example.com/images/image1.jpg")
+    #   builder.url_for("http://images.example.com/images/image2.jpg")
+    class Processing < Base
+      OPTIONS_BUILDER = OptionsBuilders::Processing
+      OPTION_ALIASES = Imgproxy::OptionAliases::PROCESSING
+
+      # @param [Hash] options Processing options
+      # @see Imgproxy.url_for
+      def initialize(options = {})
+        super(options)
+
+        @format = @options.delete(:format)
+      end
+
+      # Genrates imgproxy URL
+      #
+      # @return [String] imgproxy URL
+      # @param [String,URI, Object] image Source image URL or object applicable for
+      #   the configured URL adapters
+      # @see Imgproxy.url_for
+      def url_for(image)
+        path = [*option_strings, sourcce_url(image, ext: @format)].join("/")
+        signature = sign_path(path)
+
+        File.join(endpoint.to_s, signature, path)
+      end
+
+      # # Genrates imgproxy info URL
+      # #
+      # # @return [String] imgproxy info URL
+      # # @param [String,URI, Object] image Source image URL or object applicable for
+      # #   the configured URL adapters
+      # # @see Imgproxy.info_url_for
+      # def info_url_for(image)
+      #   path = url(image)
+      #   signature = sign_path(path)
+
+      #   File.join(endpoint.to_s, "info", signature, path)
+      # end
+    end
+  end
+end

data/lib/imgproxy/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Imgproxy
-  VERSION = "2.0.1".freeze
+  VERSION = "3.0.0"
 end

data/lib/imgproxy.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require "imgproxy/version"
 require "imgproxy/config"
-require "imgproxy/builder"
+require "imgproxy/url_builders/processing"
+require "imgproxy/url_builders/info"
 
 require "imgproxy/extensions/active_storage"
 require "imgproxy/extensions/shrine"
@@ -58,69 +61,30 @@ module Imgproxy
     # @return [String] imgproxy URL
     # @param [String,URI, Object] image Source image URL or object applicable for
     #   the configured URL adapters
-    # @param [Hash] options Processing options
-    # @option options [Hash|Array|String] :resize
-    # @option options [Hash|Array|String] :size
-    # @option options [String] :resizing_type
-    # @option options [String] :resizing_algorithm supported only by imgproxy pro
-    # @option options [Integer] :width
-    # @option options [Integer] :height
-    # @option options [Float] :dpr
-    # @option options [Boolean] :enlarge
-    # @option options [Hash|Array|Boolean|String] :extend
-    # @option options [Hash|Array|String] :gravity
-    # @option options [Hash|Array|String] :crop
-    # @option options [Array] :padding
-    # @option options [Hash|Array|String] :trim
-    # @option options [Integer] :rotate
-    # @option options [Integer] :quality
-    # @option options [Integer] :max_bytes
-    # @option options [Array|String] :background
-    # @option options [Float] :background_alpha supported only by imgproxy pro
-    # @option options [Hash|Array|String] :adjust
-    # @option options [Integer] :brightness supported only by imgproxy pro
-    # @option options [Float] :contrast supported only by imgproxy pro
-    # @option options [Float] :saturation supported only by imgproxy pro
-    # @option options [Float] :blur
-    # @option options [Float] :sharpen
-    # @option options [Integer] :pixelate supported only by imgproxy pro
-    # @option options [String] :unsharpening supported only by imgproxy pro
-    # @option options [Hash|Array|Float|String] :watermark
-    # @option options [String] :watermark_url supported only by imgproxy pro
-    # @option options [String] :style supported only by imgproxy pro
-    # @option options [Hash|Array|String] :jpeg_options supported only by imgproxy pro
-    # @option options [Hash|Array|String] :png_options supported only by imgproxy pro
-    # @option options [Hash|Array|String] :gif_options supported only by imgproxy pro
-    # @option options [Integer] :page supported only by imgproxy pro
-    # @option options [Integer] :video_thumbnail_second supported only by imgproxy pro
-    # @option options [Array] :preset
-    # @option options [String] :cachebuster
-    # @option options [Boolean] :strip_metadata
-    # @option options [Boolean] :strip_color_profile
-    # @option options [Boolean] :auto_rotate
-    # @option options [String] :filename
-    # @option options [String] :format
-    # @option options [Boolean] :use_short_options
-    # @option options [Boolean] :base64_encode_urls
-    # @option options [Boolean] :escape_plain_url
-    # @see https://docs.imgproxy.net/#/generating_the_url_advanced?id=processing-options
-    #   Available imgproxy URL processing options and their arguments
+    # @param [Hash] options Processing options.
+    #   See: {file:docs/processing_options.md Supported processing options}
     def url_for(image, options = {})
-      Imgproxy::Builder.new(options).url_for(image)
+      Imgproxy::UrlBuilders::Processing.new(options).url_for(image)
     end
 
-    # Genrates imgproxy info URL. Supported only by imgproxy pro
+    # Genrates imgproxy info URL. Supported only by imgproxy Pro
     #
-    #   Imgproxy.info_url_for("http://images.example.com/images/image.jpg")
+    #   Imgproxy.info_url_for(
+    #     "http://images.example.com/images/image.jpg",
+    #     alpha: {
+    #       alpha: true,
+    #       check_transparency: true
+    #     },
+    #     palette: 128,
+    #   )
     #
     # @return [String] imgproxy info URL
     # @param [String,URI, Object] image Source image URL or object applicable for
     #   the configured URL adapters
-    # @param [Hash] options Processing options
-    # @option options [Boolean] :base64_encode_urls
-    # @option options [Boolean] :escape_plain_url
+    # @param [Hash] options Info options.
+    #   See: {file:docs/info_options.md Supported info options}
     def info_url_for(image, options = {})
-      Imgproxy::Builder.new(options).info_url_for(image)
+      Imgproxy::UrlBuilders::Info.new(options).url_for(image)
     end
 
     # Extends +ActiveStorage::Blob+ with {Imgproxy::Extensions::ActiveStorage.imgproxy_url} method