imgproxy 1.0.6 → 2.0.1

data/lib/imgproxy/options_casters/bool.rb

@@ -0,0 +1,12 @@
+module Imgproxy
+  module OptionsCasters
+    # Casts boolean option
+    module Bool
+      def self.cast(raw)
+        return if raw.nil?
+
+        raw && raw != 0 && raw != "0" ? 1 : 0
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/crop.rb

@@ -0,0 +1,23 @@
+require "imgproxy/trim_array"
+require "imgproxy/options_casters/float"
+require "imgproxy/options_casters/gravity"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts crop option
+    module Crop
+      using TrimArray
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+        return unless raw[:width] || raw[:height]
+
+        [
+          Imgproxy::OptionsCasters::Float.cast(raw[:width]) || 0,
+          Imgproxy::OptionsCasters::Float.cast(raw[:height]) || 0,
+          Imgproxy::OptionsCasters::Gravity.cast(raw[:gravity]),
+        ].trim!
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/extend.rb

@@ -0,0 +1,26 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/bool"
+require "imgproxy/options_casters/gravity"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts extend option
+    module Extend
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        extend: Imgproxy::OptionsCasters::Bool,
+        gravity: Imgproxy::OptionsCasters::Gravity,
+      ).freeze
+
+      def self.cast(raw)
+        # Allow extend to be just a boolean
+        return Imgproxy::OptionsCasters::Bool.cast(raw) if [true, false].include?(raw)
+
+        return raw unless raw.is_a?(Hash)
+        return if raw[:extend].nil?
+
+        values = CASTER.cast(raw)
+        values[0].zero? ? 0 : values
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/float.rb

@@ -0,0 +1,16 @@
+module Imgproxy
+  module OptionsCasters
+    # Casts float option
+    module Float
+      ZERO_RE = /\.0+/.freeze
+
+      def self.cast(raw)
+        raw&.to_f&.yield_self do |f|
+          # Convert integral value to Integer so to_s won't give us trailing zero
+          i = f.to_i
+          i == f ? i : f
+        end
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/gif_options.rb

@@ -0,0 +1,21 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/bool"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts gif_options option
+    module GifOptions
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        optimize_frames: Imgproxy::OptionsCasters::Bool,
+        optimize_transparency: Imgproxy::OptionsCasters::Bool,
+      ).freeze
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        values = CASTER.cast(raw)
+        values.empty? ? nil : values
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/gravity.rb

@@ -0,0 +1,23 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/string"
+require "imgproxy/options_casters/float"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts gravity option
+    module Gravity
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        type: Imgproxy::OptionsCasters::String,
+        x_offset: Imgproxy::OptionsCasters::Float,
+        y_offset: Imgproxy::OptionsCasters::Float,
+      ).freeze
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+        return unless raw[:type]
+
+        CASTER.cast(raw)
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/group.rb

@@ -0,0 +1,21 @@
+require "imgproxy/trim_array"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts group of options and trim nils from the end
+    class Group
+      using TrimArray
+
+      def initialize(extractors)
+        @extractors = extractors
+      end
+
+      def cast(raw)
+        values = @extractors.map do |key, extractor|
+          extractor.cast(raw[key])
+        end
+        values.trim!
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/integer.rb

@@ -0,0 +1,10 @@
+module Imgproxy
+  module OptionsCasters
+    # Casts integer option
+    module Integer
+      def self.cast(raw)
+        raw&.to_i
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/jpeg_options.rb

@@ -0,0 +1,26 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/bool"
+require "imgproxy/options_casters/integer"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts jpeg_options option
+    module JpegOptions
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        progressive: Imgproxy::OptionsCasters::Bool,
+        no_subsample: Imgproxy::OptionsCasters::Bool,
+        trellis_quant: Imgproxy::OptionsCasters::Bool,
+        overshoot_deringing: Imgproxy::OptionsCasters::Bool,
+        optimize_scans: Imgproxy::OptionsCasters::Bool,
+        quant_table: Imgproxy::OptionsCasters::Integer,
+      ).freeze
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        values = CASTER.cast(raw)
+        values.empty? ? nil : values
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/png_options.rb

@@ -0,0 +1,23 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/bool"
+require "imgproxy/options_casters/integer"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts png_options option
+    module PngOptions
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        interlaced: Imgproxy::OptionsCasters::Bool,
+        quantize: Imgproxy::OptionsCasters::Bool,
+        quantization_colors: Imgproxy::OptionsCasters::Integer,
+      ).freeze
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        values = CASTER.cast(raw)
+        values.empty? ? nil : values
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/resize.rb

@@ -0,0 +1,21 @@
+require "imgproxy/trim_array"
+require "imgproxy/options_casters/string"
+require "imgproxy/options_casters/size"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts resize option
+    module Resize
+      using TrimArray
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        [
+          Imgproxy::OptionsCasters::String.cast(raw[:resizing_type]) || "fit",
+          *Imgproxy::OptionsCasters::Size.cast(raw),
+        ].trim!
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/size.rb

@@ -0,0 +1,24 @@
+require "imgproxy/trim_array"
+require "imgproxy/options_casters/integer"
+require "imgproxy/options_casters/bool"
+require "imgproxy/options_casters/extend"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts size option
+    module Size
+      using TrimArray
+
+      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,
+          Imgproxy::OptionsCasters::Bool.cast(raw[:enlarge]),
+          Imgproxy::OptionsCasters::Extend.cast(raw[:extend]),
+        ].trim!
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/string.rb

@@ -0,0 +1,10 @@
+module Imgproxy
+  module OptionsCasters
+    # Casts string option
+    module String
+      def self.cast(raw)
+        raw&.to_s
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/trim.rb

@@ -0,0 +1,28 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/float"
+require "imgproxy/options_casters/string"
+require "imgproxy/options_casters/bool"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts trim option
+    module Trim
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        threshold: Imgproxy::OptionsCasters::Float,
+        color: Imgproxy::OptionsCasters::String,
+        equal_hor: Imgproxy::OptionsCasters::Bool,
+        equal_ver: Imgproxy::OptionsCasters::Bool,
+      ).freeze
+
+      def self.cast(raw)
+        # Allow trim to be just a numeric
+        return Imgproxy::OptionsCasters::Float.cast(raw) if raw.is_a?(Numeric)
+
+        return raw unless raw.is_a?(Hash)
+        return unless raw[:threshold]
+
+        CASTER.cast(raw)
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/watermark.rb

@@ -0,0 +1,30 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/float"
+require "imgproxy/options_casters/string"
+require "imgproxy/options_casters/integer"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts string option
+    module Watermark
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        opacity: Imgproxy::OptionsCasters::Float,
+        position: Imgproxy::OptionsCasters::String,
+        x_offset: Imgproxy::OptionsCasters::Integer,
+        y_offset: Imgproxy::OptionsCasters::Integer,
+        scale: Imgproxy::OptionsCasters::Float,
+      ).freeze
+
+      def self.cast(raw)
+        # Allow watermark to be just a numeric
+        return Imgproxy::OptionsCasters::Float.cast(raw) if raw.is_a?(Numeric)
+
+        return raw unless raw.is_a?(Hash)
+        return unless raw[:opacity]
+
+        values = CASTER.cast(raw)
+        values[0].zero? ? 0 : values
+      end
+    end
+  end
+end

data/lib/imgproxy/trim_array.rb

@@ -0,0 +1,11 @@
+module Imgproxy
+  # `Array.trim!` refinement
+  module TrimArray
+    refine Array do
+      def trim!
+        delete_at(-1) while !empty? && last.nil?
+        self
+      end
+    end
+  end
+end

data/lib/imgproxy/url_adapters/active_storage.rb

@@ -15,8 +15,33 @@ module Imgproxy
       end
 
       def url(image)
+        return s3_url(image) if use_s3_url(image)
+        return gcs_url(image) if use_gcs_url(image)
+
         Rails.application.routes.url_helpers.url_for(image)
       end
+
+      private
+
+      def s3_url(image)
+        "s3://#{image.service.bucket.name}/#{image.key}"
+      end
+
+      def use_s3_url(image)
+        config.use_s3_urls && image.service.is_a?(::ActiveStorage::Service::S3Service)
+      end
+
+      def gcs_url(image)
+        "gs://#{config.gcs_bucket}/#{image.key}"
+      end
+
+      def use_gcs_url(image)
+        config.use_gcs_urls && image.service.is_a?(::ActiveStorage::Service::GCSService)
+      end
+
+      def config
+        Imgproxy.config
+      end
     end
   end
 end

data/lib/imgproxy/url_adapters/shrine.rb

@@ -8,19 +8,29 @@ module Imgproxy
     #
     #   Imgproxy.url_for(user.avatar)
     class Shrine
-      def initialize(host: nil)
-        @host = host
-      end
-
       def applicable?(image)
         image.is_a?(::Shrine::UploadedFile)
       end
 
       def url(image)
+        return s3_url(image) if use_s3_url(image)
+
         opts = {}
-        opts[:host] = @host if @host
+        opts[:host] = Imgproxy.config.shrine_host if Imgproxy.config.shrine_host
         image.url(opts)
       end
+
+      private
+
+      def s3_url(image)
+        path = [*image.storage.prefix, image.id].join("/")
+        "s3://#{image.storage.bucket.name}/#{path}"
+      end
+
+      def use_s3_url(image)
+        Imgproxy.config.use_s3_urls &&
+          image.storage.is_a?(::Shrine::Storage::S3)
+      end
     end
   end
 end

data/lib/imgproxy/url_adapters.rb

@@ -1,9 +1,5 @@
 require "imgproxy/url_adapters/active_storage"
-require "imgproxy/url_adapters/active_storage_s3"
-require "imgproxy/url_adapters/active_storage_gcs"
-
 require "imgproxy/url_adapters/shrine"
-require "imgproxy/url_adapters/shrine_s3"
 
 module Imgproxy
   # URL adapters config. Allows to use this gem with ActiveStorage, Shrine, etc.

data/lib/imgproxy/version.rb

@@ -1,3 +1,3 @@
 module Imgproxy
-  VERSION = "1.0.6".freeze
+  VERSION = "2.0.1".freeze
 end

data/lib/imgproxy.rb

@@ -19,8 +19,8 @@ module Imgproxy
     #
     #   Imgproxy.configure do |config|
     #     config.endpoint = "http://imgproxy.example.com"
-    #     config.hex_key = "your_key"
-    #     config.hex_salt = "your_salt"
+    #     config.key = "your_key"
+    #     config.salt = "your_salt"
     #     config.use_short_options = true
     #   end
     #
@@ -38,72 +38,112 @@ module Imgproxy
     #     width: 500,
     #     height: 400,
     #     resizing_type: :fill,
-    #     sharpen: 0.5
+    #     sharpen: 0.5,
+    #     gravity: {
+    #       type: :soea,
+    #       x_offset: 10,
+    #       y_offset: 5,
+    #     },
+    #     crop: {
+    #       width: 2000,
+    #       height: 1000,
+    #       gravity: {
+    #         type: :nowe,
+    #         x_offset: 20,
+    #         y_offset: 30,
+    #       },
+    #     },
     #   )
     #
     # @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 [Boolean] :extend
-    # @option options [String] :gravity
-    # @option options [Float] :gravity_x
-    # @option options [Float] :gravity_y
+    # @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 [Array] :background
+    # @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 [Float] :watermark_opacity
-    # @option options [String] :watermark_position
-    # @option options [Integer] :watermark_x_offset
-    # @option options [Integer] :watermark_y_offset
-    # @option options [Float] :watermark_scale
+    # @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
-    # @see https://github.com/DarthSim/imgproxy/blob/master/docs/generating_the_url_advanced.md
-    #   imgproxy URL format documentation
+    # @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
     def url_for(image, options = {})
       Imgproxy::Builder.new(options).url_for(image)
     end
 
-    # Extends ActiveStorage::Blob with {Imgproxy::Extensions::ActiveStorage.imgproxy_url} method
-    # and adds URL adapters for ActiveStorage
+    # Genrates imgproxy info URL. Supported only by imgproxy pro
     #
-    # @return [void]
-    # @param use_s3 [Boolean] enable Amazon S3 source URLs
-    # @param use_gcs [Boolean] enable Google Cloud Storage source URLs
-    # @param gcs_bucket [String] Google Cloud Storage bucket name
-    def extend_active_storage!(use_s3: false, use_gcs: false, gcs_bucket: nil)
-      ActiveSupport.on_load(:active_storage_blob) do
-        ::ActiveStorage::Blob.include Imgproxy::Extensions::ActiveStorage
+    #   Imgproxy.info_url_for("http://images.example.com/images/image.jpg")
+    #
+    # @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
+    def info_url_for(image, options = {})
+      Imgproxy::Builder.new(options).info_url_for(image)
+    end
 
-        url_adapters = Imgproxy.config.url_adapters
+    # Extends +ActiveStorage::Blob+ with {Imgproxy::Extensions::ActiveStorage.imgproxy_url} method
+    # and adds URL adapters for ActiveStorage
+    def extend_active_storage!
+      return unless defined?(ActiveSupport) && ActiveSupport.respond_to?(:on_load)
 
-        url_adapters.add(Imgproxy::UrlAdapters::ActiveStorageS3.new) if use_s3
-        url_adapters.add(Imgproxy::UrlAdapters::ActiveStorageGCS.new(gcs_bucket)) if use_gcs
-        url_adapters.add(Imgproxy::UrlAdapters::ActiveStorage.new)
+      ActiveSupport.on_load(:active_storage_blob) do
+        ::ActiveStorage::Blob.include Imgproxy::Extensions::ActiveStorage
+        Imgproxy.config.url_adapters.add(Imgproxy::UrlAdapters::ActiveStorage.new)
       end
     end
 
-    # Extends Shrine::UploadedFile with {Imgproxy::Extensions::Shrine.imgproxy_url} method
+    # Extends +Shrine::UploadedFile+ with {Imgproxy::Extensions::Shrine.imgproxy_url} method
     # and adds URL adapters for Shrine
-    #
-    # @return [void]
-    # @param use_s3 [Boolean] enable Amazon S3 source URLs
-    def extend_shrine!(host: nil, use_s3: false)
-      ::Shrine::UploadedFile.include Imgproxy::Extensions::Shrine
-
-      url_adapters = Imgproxy.config.url_adapters
+    def extend_shrine!
+      return unless defined?(::Shrine::UploadedFile)
 
-      url_adapters.add(Imgproxy::UrlAdapters::ShrineS3.new) if use_s3
-      url_adapters.add(Imgproxy::UrlAdapters::Shrine.new(host: host))
+      ::Shrine::UploadedFile.include Imgproxy::Extensions::Shrine
+      Imgproxy.config.url_adapters.add(Imgproxy::UrlAdapters::Shrine.new)
     end
   end
 end
+
+Imgproxy.extend_active_storage!
+Imgproxy.extend_shrine!