imgproxy 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 408a45b49e0ddd25815dd6a3f904a93a9df27e9d00e31dcfccab11a9cf841196
-  data.tar.gz: b43ff3e7f9c80922937729921ea1a2fc5187974298ff19f5190191ff2a2d4b95
+  metadata.gz: 138bb555a390e397e8bdc3e5f68534416bac212660f1c48aa2fc8332e5ab4828
+  data.tar.gz: 73d3c3357b1eb2959084b827e790e2aaa2145499ec69539a069d47e02e160c43
 SHA512:
-  metadata.gz: d92e1e4782e614a0f445766e4f1d4b6b985564e4877b1a0230b2717b337acfea7d2ff09ff12cc9cbf1ea86312a5bc7c2c382102a9651f3e390ea4cdb7fadc68b
-  data.tar.gz: 6de6077c86b0d9a83dcb3673d35b9a28a0586ec9612211d233ed8fffc935de5ee8c587311fe695c7df882a3af42b558e221ac5f081a308274ace6c102a5ddf69
+  metadata.gz: 8891f46189c8b7a646d8fbed5202e7b66f51e63357b999158fc71c3fae19b5d3ae38a48c21f2acac7d937b6f53c512fe4f4654c528bb1a3e4a83ade50f065535
+  data.tar.gz: 82821cd8bd891a5dc0ed51846e490b09228ac070e2d0b1dd8af544c8046fc998f628e2cd283ee8011e7d365b2a3c087241129b3fe0d8c88d13e751b260fa9b5b

data/README.md

@@ -51,6 +51,9 @@ Imgproxy.configure do |config|
   config.hex_key = "your_key"
   # Hex-encoded signature salt
   config.hex_salt = "your_salt"
+
+  # Base64 encode all URLs
+  # config.base64_encode_urls = true
 end
 ```
 
@@ -167,9 +170,16 @@ builder.url_for("http://images.example.com/images/image2.jpg")
 * `dpr` — when set, imgproxy will multiply the image dimensions according to this factor for HiDPI (Retina) devices.
 * `enlarge` — when true, imgproxy will enlarge the image if it is smaller than the given size.
 * `extend` — when true, imgproxy will extend the image if the resizing result is smaller than the given size.
+* `extend_gravity`, `extend_gravity_x`, `extend_gravity_y` — define the gravity of the extend. These options accept the same values as `gravity`, `gravity_x` and `gravity_y` (see below).
 * `gravity` — defines gravity that will be used when imgproxy needs to cut some parts of the image. See [URL format guide](https://github.com/imgproxy/imgproxy/blob/master/docs/generating_the_url_advanced.md#gravity) for available values.
-* `gravity_x`, `gravity_y` — floating point numbers between 0 and 1 that define the coordinates of the center of the resulting image when `fp` gravity is used.
+* `gravity_x`, `gravity_y` — specify gravity offset by X and Y axes. When `fp` gravity is used, these are floating point numbers between 0 and 1 that define the coordinates of the center of the resulting image.
+* `crop_width`, `crop_height` — define the size of an area of the image to be processed (crop before resize).
+* `crop_gravity`, `crop_gravity_x`, `crop_gravity_y` - define the gravity of the crop. These options accept the same values as `gravity`, `gravity_x` and `gravity_y` (see above).
+* `padding` - defines padding size in css manner (you can use array here). See [URL guide](https://docs.imgproxy.net/#/generating_the_url_advanced?id=padding) for more info.
+* `trim_threshold` - when set, imgproxy removes surrounding background.
+* `trim_color`, `trim_equal_hor`, `trim_equal_ver` - additional trim options described in the [URL guide](https://docs.imgproxy.net/#/generating_the_url_advanced?id=trim).
 * `quality` — defines the quality of the resulting image, percentage.
+* `max_bytes` — when set, imgproxy automatically degrades the quality of the image until the image is under the specified amount of bytes.
 * `background` — when set, imgproxy will fill the resulting image background with the specified color. Can be a hex-color string or an array of red, green and blue values (0-255).
 * `brightness` — when set, imgproxy will adjust brightness of the resulting image. _Supported only by imgproxy pro._
 * `contrast` — when set, imgproxy will adjust contrast of the resulting image. _Supported only by imgproxy pro._
@@ -179,10 +189,12 @@ builder.url_for("http://images.example.com/images/image2.jpg")
 * `pixelate` — when set, imgproxy will apply the pixelate filter to the resulting image. Value is the size of a pixel. _Supported only by imgproxy pro._
 * `watermark_opacity` — when set, imgproxy will put a watermark on the resulting image. See [watermars guide](https://github.comimgproxym/imgproxy/blob/master/docs/watermark.md) for more info.
 * `watermark_position`, `watermark_x_offset`, `watermark_y_offset`, `watermark_scale` — additional watermark options described in the [watermars guide](https://github.com/imgproxy/imgproxy/blob/master/docs/watermark.md).
-* `style` - when set, imgproxy will prepend `<style>` node with provided content to the `<svg>` node of source SVG image. _Supported only by imgproxy pro._
+* `watermark_url` — when set, imgproxy will use the image from the specified URL as a watermark. _Supported only by imgproxy pro._
+* `style` — when set, imgproxy will prepend `<style>` node with provided content to the `<svg>` node of source SVG image. _Supported only by imgproxy pro._
 * `preset` — array of names of presets that will be used by imgproxy. See [presets guide](https://github.com/imgproxy/imgproxy/blob/master/docs/presets.md) for more info.
 * `cachebuster` — defines cache buster that doesn't affect image processing but it's changing allows to bypass CDN, proxy server and browser cache.
 * `format` — specifies the resulting image format (`jpg`, `png`, `webp`).
+* `base64_encode_url` — encode the URL as a base64 string.
 * `use_short_options` — per-call redefinition of `use_short_options` config.
 
 **See [imgproxy URL format guide](https://github.com/imgproxy/imgproxy/blob/master/docs/generating_the_url_advanced.md) for more info.**
@@ -253,3 +265,7 @@ If you are having any problems with image processing of imgproxy itself, be sure
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Security Contact
+
+To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.

data/lib/imgproxy.rb

@@ -45,21 +45,30 @@ module Imgproxy
     # @param [String,URI, Object] image Source image URL or object applicable for
     #   the configured URL adapters
     # @param [Hash] options Processing options
-    # @option options [Integer] :crop_width
-    # @option options [Integer] :crop_height
-    # @option options [String] :crop_gravity
-    # @option options [Float] :crop_gravity_x
-    # @option options [Float] :crop_gravity_y
     # @option options [String] :resizing_type
     # @option options [Integer] :width
     # @option options [Integer] :height
     # @option options [Float] :dpr
     # @option options [Boolean] :enlarge
     # @option options [Boolean] :extend
+    # @option options [String] :extend_gravity
+    # @option options [Float] :extend_gravity_x
+    # @option options [Float] :extend_gravity_y
     # @option options [String] :gravity
     # @option options [Float] :gravity_x
     # @option options [Float] :gravity_y
+    # @option options [Integer] :crop_width
+    # @option options [Integer] :crop_height
+    # @option options [String] :crop_gravity
+    # @option options [Float] :crop_gravity_x
+    # @option options [Float] :crop_gravity_y
+    # @option options [Integer] :trim_threshold
+    # @option options [String] :trim_color
+    # @option options [Array] :padding
+    # @option options [Boolean] :trim_equal_hor
+    # @option options [Boolean] :trim_equal_ver
     # @option options [Integer] :quality
+    # @option options [Integer] :max_bytes
     # @option options [Array] :background
     # @option options [Integer] :brightness supported only by imgproxy pro
     # @option options [Float] :contrast supported only by imgproxy pro
@@ -77,6 +86,7 @@ module Imgproxy
     # @option options [String] :cachebuster
     # @option options [String] :format
     # @option options [Boolean] :use_short_options
+    # @option options [Boolean] :base64_encode_urls
     # @see https://github.com/DarthSim/imgproxy/blob/master/docs/generating_the_url_advanced.md
     #   imgproxy URL format documentation
     def url_for(image, options = {})

data/lib/imgproxy/builder.rb

@@ -17,13 +17,17 @@ module Imgproxy
   #   builder.url_for("http://images.example.com/images/image1.jpg")
   #   builder.url_for("http://images.example.com/images/image2.jpg")
   class Builder
+    OMITTED_OPTIONS = %i[format].freeze
     # @param [Hash] options Processing options
     # @see Imgproxy.url_for
     def initialize(options = {})
       options = options.dup
 
+      @base64_encode_url = options.delete(:base64_encode_url)
       @use_short_options = options.delete(:use_short_options)
+
       @use_short_options = config.use_short_options if @use_short_options.nil?
+      @base64_encode_url = config.base64_encode_urls if @base64_encode_url.nil?
 
       @options = Imgproxy::Options.new(options)
     end
@@ -35,9 +39,7 @@ module Imgproxy
     #   the configured URL adapters
     # @see Imgproxy.url_for
     def url_for(image)
-      path = [*processing_options, "plain", url(image)].join("/")
-      path = "#{path}@#{@options[:format]}" if @options[:format]
-
+      path = [*processing_options, url(image)].join("/")
       signature = sign_path(path)
 
       File.join(Imgproxy.config.endpoint.to_s, signature, path)
@@ -46,7 +48,6 @@ module Imgproxy
     private
 
     OPTIONS_ALIASES = {
-      crop: :c,
       resize: :rs,
       size: :s,
       resizing_type: :rt,
@@ -55,7 +56,11 @@ module Imgproxy
       enlarge: :en,
       extend: :ex,
       gravity: :g,
+      crop: :c,
+      padding: :pd,
+      trim: :t,
       quality: :q,
+      max_bytes: :mb,
       background: :bg,
       adjust: :a,
       brightness: :br,
@@ -74,11 +79,23 @@ module Imgproxy
 
     def processing_options
       @processing_options ||=
-        @options.reject { |k, _| k == :format }.map do |key, value|
+        @options.reject { |k, _| OMITTED_OPTIONS.include?(k) }.map do |key, value|
           "#{option_alias(key)}:#{wrap_array(value).join(':')}"
         end
     end
 
+    def plain_url_for(url)
+      escaped_url = url.match?(NEED_ESCAPE_RE) ? ERB::Util.url_encode(url) : url
+
+      @options[:format] ? "plain/#{escaped_url}@#{@options[:format]}" : "plain/#{escaped_url}"
+    end
+
+    def base64_url_for(url)
+      encoded_url = Base64.urlsafe_encode64(url).tr("=", "").scan(/.{1,16}/).join("/")
+
+      @options[:format] ? "#{encoded_url}.#{@options[:format]}" : encoded_url
+    end
+
     def option_alias(name)
       return name unless config.use_short_options
 
@@ -91,7 +108,8 @@ module Imgproxy
 
     def url(image)
       url = config.url_adapters.url_of(image)
-      url.match?(NEED_ESCAPE_RE) ? ERB::Util.url_encode(url) : url
+
+      @base64_encode_url ? base64_url_for(url) : plain_url_for(url)
     end
 
     def sign_path(path)

data/lib/imgproxy/config.rb

@@ -17,9 +17,14 @@ module Imgproxy
     #   Defaults to true
     attr_accessor :use_short_options
 
+    # @return [Boolean] base64 encode the URL
+    #   Defaults to false
+    attr_accessor :base64_encode_urls
+
     def initialize
       self.signature_size = 32
       self.use_short_options = true
+      self.base64_encode_urls = false
     end
 
     # Decodes hex-encoded key and sets it to {#key}

data/lib/imgproxy/options.rb

@@ -1,18 +1,20 @@
 module Imgproxy
   # Formats and regroups processing options
   class Options < Hash
-    STRING_OPTS = %i[resizing_type gravity crop_gravity watermark_position watermark_url style
-                     cachebuster format].freeze
-    INT_OPTS = %i[width height crop_width crop_height
-                  quality brightness pixelate watermark_x_offset watermark_y_offset].freeze
-    FLOAT_OPTS = %i[dpr gravity_x gravity_y crop_gravity_x crop_gravity_y contrast saturation
-                    blur sharpen watermark_opacity watermark_scale].freeze
-    BOOL_OPTS = %i[enlarge extend].freeze
-    ARRAY_OPTS = %i[background preset].freeze
+    STRING_OPTS = %i[resizing_type extend_gravity gravity crop_gravity trim_color watermark_position
+                     watermark_url style cachebuster format base64_encode_url].freeze
+    INT_OPTS = %i[width height crop_width crop_height trim_threshold quality brightness pixelate
+                  watermark_x_offset watermark_y_offset max_bytes].freeze
+    FLOAT_OPTS = %i[dpr extend_gravity_x extend_gravity_y gravity_x gravity_y crop_gravity_x
+                    crop_gravity_y contrast saturation blur sharpen watermark_opacity
+                    watermark_scale].freeze
+    BOOL_OPTS = %i[enlarge extend trim_equal_hor trim_equal_ver].freeze
+    ARRAY_OPTS = %i[padding background preset].freeze
     ALL_OPTS = (STRING_OPTS + INT_OPTS + FLOAT_OPTS + BOOL_OPTS + ARRAY_OPTS).freeze
 
-    OPTS_PRIORITY = %i[ crop resize size resizing_type width height dpr enlarge extend gravity
-                        quality background blur sharpen pixelate watermark watermark_url preset
+    OPTS_PRIORITY = %i[ resize size resizing_type width height dpr enlarge extend gravity
+                        crop padding trim quality max_bytes background adjust brightness contrast
+                        saturation blur sharpen pixelate watermark watermark_url style preset
                         cachebuster ].freeze
 
     # @param options [Hash] raw processing options
@@ -56,10 +58,12 @@ module Imgproxy
 
     def group_options
       group_crop_opts
+      group_extend_opts
       group_resizing_opts
       group_gravity_opts
       group_adjust_opts
       group_watermark_opts
+      group_trim_opts
     end
 
     def group_crop_opts
@@ -88,6 +92,16 @@ module Imgproxy
       self[:gravity] = gravity unless gravity[0].nil?
     end
 
+    def group_extend_opts
+      extend_opts =
+        extract_and_trim_nils(:extend, :extend_gravity, :extend_gravity_x, :extend_gravity_y)
+
+      return if extend_opts[0].nil?
+      return self[:extend] = 0 if extend_opts[0].zero?
+
+      self[:extend] = extend_opts
+    end
+
     def group_adjust_opts
       return unless values_at(:brightness, :contrast, :saturation).count { |o| !o.nil? } > 1
 
@@ -106,6 +120,17 @@ module Imgproxy
       self[:watermark] = watermark unless watermark[0].nil?
     end
 
+    def group_trim_opts
+      trim = extract_and_trim_nils(
+        :trim_threshold,
+        :trim_color,
+        :trim_equal_hor,
+        :trim_equal_ver,
+      )
+
+      self[:trim] = trim unless trim[0].nil?
+    end
+
     def encode_style
       return if self[:style].nil?
       self[:style] = Base64.urlsafe_encode64(self[:style]).tr("=", "")

data/lib/imgproxy/url_adapters/shrine_s3.rb

@@ -13,7 +13,8 @@ module Imgproxy
       end
 
       def url(image)
-        "s3://#{image.storage.bucket.name}/#{image.id}"
+        path = [*image.storage.prefix, image.id].join("/")
+        "s3://#{image.storage.bucket.name}/#{path}"
       end
     end
   end

data/lib/imgproxy/version.rb

@@ -1,3 +1,3 @@
 module Imgproxy
-  VERSION = "1.1.0".freeze
+  VERSION = "1.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imgproxy
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Sergey Alexandrovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2020-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.66.0
+        version: 0.83.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.66.0
+        version: 0.83.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.32.0
+        version: 1.38.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.32.0
+        version: 1.38.1
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.35.0
+        version: 1.64.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.35.0
+        version: 1.64.0
 - !ruby/object:Gem::Dependency
   name: google-cloud-storage
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.4.1
 description: A gem that easily generates imgproxy URLs for your images
 email: darthsim@gmail.com
 executables: []
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: imgproxy URL generator