imgix 3.3.1 → 4.0.3

data/lib/imgix/path.rb

@@ -1,55 +1,29 @@
 # frozen_string_literal: true
 
-require 'base64'
-require 'cgi/util'
-require 'erb'
-require 'imgix/param_helpers'
+require "base64"
+require "cgi/util"
+require "erb"
 
 module Imgix
   class Path
-    include ParamHelpers
 
-    ALIASES = {
-      width: :w,
-      height: :h,
-      rotation: :rot,
-      noise_reduction: :nr,
-      sharpness: :sharp,
-      exposure: :exp,
-      vibrance: :vib,
-      saturation: :sat,
-      brightness: :bri,
-      contrast: :con,
-      highlight: :high,
-      shadow: :shad,
-      gamma: :gam,
-      pixelate: :px,
-      halftone: :htn,
-      watermark: :mark,
-      text: :txt,
-      format: :fm,
-      quality: :q
-    }.freeze
-
-    def initialize(prefix, secure_url_token, path = '/')
+    def initialize(prefix, secure_url_token, path = "/")
       @prefix = prefix
       @secure_url_token = secure_url_token
       @path = path
       @options = {}
-
-      @path = CGI.escape(@path) if /^https?/ =~ @path
-      @path = "/#{@path}" if @path[0] != '/'
-      @target_widths = TARGET_WIDTHS.call(DEFAULT_WIDTH_TOLERANCE, MIN_WIDTH, MAX_WIDTH)
     end
 
     def to_url(opts = {})
+      sanitized_path = sanitize_path(@path)
       prev_options = @options.dup
       @options.merge!(opts)
 
-      url = @prefix + path_and_params
+      current_path_and_params = path_and_params(sanitized_path)
+      url = @prefix + current_path_and_params
 
       if @secure_url_token
-        url += (has_query? ? '&' : '?') + "s=#{signature}"
+        url += (has_query? ? "&" : "?") + "s=#{signature(current_path_and_params)}"
       end
 
       @options = prev_options
@@ -61,61 +35,139 @@ module Imgix
       self
     end
 
+    def ixlib(lib_version)
+      @options[:ixlib] = lib_version
+    end
+
+    def ixlib=(lib_version)
+      @options[:ixlib] = lib_version
+    end
+
+    def to_srcset(options: {}, **params)
+      prev_options = @options.dup
+      @options.merge!(params)
+
+      width = @options[:w]
+      height = @options[:h]
+      aspect_ratio = @options[:ar]
+
+      srcset = if width || height
+          build_dpr_srcset(options: options, params: @options)
+        else
+          build_srcset_pairs(options: options, params: @options)
+        end
+
+      @options = prev_options
+      srcset
+    end
+
+    ALIASES = {
+      width:           :w,
+      height:          :h,
+      rotation:        :rot,
+      noise_reduction: :nr,
+      sharpness:       :sharp,
+      exposure:        :exp,
+      vibrance:        :vib,
+      saturation:      :sat,
+      brightness:      :bri,
+      contrast:        :con,
+      highlight:       :high,
+      shadow:          :shad,
+      gamma:           :gam,
+      pixelate:        :px,
+      halftone:        :htn,
+      watermark:       :mark,
+      text:            :txt,
+      format:          :fm,
+      quality:         :q,
+      fill_color:      :fillcolor
+    }.freeze
+
+    # Define query parameters on a Path (via method_missing).
+    # Normally, when overriding method_missing, it is a best practice
+    # to fall back to super, but this method works differently.
+    #
+    # method_missing intercepts messages sent to objects of this class
+    # and acts as a getter, setter, and deleter. If there are no args,
+    # e.g. `path.width`, then this method acts like a getter.
+    #
+    # Likewise, if the first argument is nil and the method name exists
+    # as a key in @options, e.g. `path.param_name = nil`, then this
+    # method acts like a deleter and the `param_name` is removed from
+    # the list of @options.
+    #
+    # Finally, in _all_ other cases, the `method` name is used as the
+    # `key` and the `*args` are used as the value.
     def method_missing(method, *args, &block)
       key = method.to_s.gsub('=', '')
-      if args.length == 0
+
+      if args.length == 0 # Get, or
         return @options[key]
-      elsif args.first.nil? && @options.has_key?(key)
+      elsif args.first.nil? && @options.has_key?(key) # Delete, or
         @options.delete(key) and return self
       end
 
-      @options[key] = args.join(',')
+      @options[key] = args.join(',') # Set the option.
       self
     end
 
+    # Use ALIASES to define setters for a subset of imgix parameters.
+    # E.g. `path.width(100)` would result in `send(:w, [100])`.
     ALIASES.each do |from, to|
       define_method from do |*args|
-        warn "Warning: `Path.#{from}' has been deprecated and " \
-             "will be removed in the next major version (along " \
-             "with all parameter `ALIASES`).\n"
         self.send(to, *args)
       end
 
+      # E.g. `path.width = 100` would result in `send(":w=", [100])`.
       define_method "#{from}=" do |*args|
-        warn "Warning: `Path.#{from}=' has been deprecated and " \
-             "will be removed in the next major version (along " \
-             "with all parameter `ALIASES`).\n"
         self.send("#{to}=", *args)
         return self
       end
     end
 
-    def to_srcset(options: {}, **params)
-      prev_options = @options.dup
-      @options.merge!(params)
-
-      width = @options[:w]
-      height = @options[:h]
-      aspect_ratio = @options[:ar]
+    private
 
-      srcset = if width || (height && aspect_ratio)
-                 build_dpr_srcset(options: options, params: @options)
-               else
-                 build_srcset_pairs(options: options, params: @options)
-               end
+    # Escape and encode any characters in path that are reserved and not utf8 encoded.
+    # This includes " +?:#" characters. If a path is being used as a proxy, utf8
+    # encode everything. If it is not being used as proxy, leave certain chars, like
+    # "/", alone. Method assumes path is not already encoded.
+    def sanitize_path(path)
+      # remove the leading "/", we'll add it back after encoding
+      path = path.slice(1, path.length) if Regexp.new('^/') =~ path
+      # if path is being used as a proxy, encode the entire thing
+      if /^https?/ =~ path
+        return encode_URI_Component(path)
+      else
+        # otherwise, encode only specific characters
+        return encode_URI(path)
+      end
+    end
 
-      @options = prev_options
-      srcset
+    # URL encode the entire path
+    def encode_URI_Component(path)
+      return "/" + ERB::Util.url_encode(path)
     end
 
-    private
+    # URL encode every character in the path, including
+    # " +?:#" characters.
+    def encode_URI(path)
+      # For each component in the path, URL encode it and add it
+      # to the array path component.
+      path_components = []
+      path.split("/").each do |str|
+        path_components << ERB::Util.url_encode(str)
+      end
+      # Prefix and join the encoded path components.
+      "/#{path_components.join('/')}"
+    end
 
-    def signature
-      Digest::MD5.hexdigest(@secure_url_token + path_and_params)
+    def signature(rest)
+      Digest::MD5.hexdigest(@secure_url_token + rest)
     end
 
-    def path_and_params
-      has_query? ? "#{@path}?#{query}" : @path
+    def path_and_params(path)
+      has_query? ? "#{path}?#{query}" : path
     end
 
     def query
@@ -127,15 +179,15 @@ module Imgix
         else
           escaped_key << "=" << ERB::Util.url_encode(val.to_s)
         end
-      end.join('&')
+      end.join("&")
     end
 
     def has_query?
-      query.length > 0
+      !query.empty?
     end
 
     def build_srcset_pairs(options:, params:)
-      srcset = ''
+      srcset = ""
 
       widths = options[:widths] || []
       width_tolerance = options[:width_tolerance] || DEFAULT_WIDTH_TOLERANCE
@@ -150,10 +202,10 @@ module Imgix
         validate_width_tolerance!(width_tolerance)
         srcset_widths = TARGET_WIDTHS.call(width_tolerance, min_width, max_width)
       else
-        srcset_widths = @target_widths
+        srcset_widths = DEFAULT_TARGET_WIDTHS
       end
 
-      for width in srcset_widths do
+      srcset_widths.each do |width|
         params[:w] = width
         srcset += "#{to_url(params)} #{width}w,\n"
       end
@@ -162,7 +214,7 @@ module Imgix
     end
 
     def build_dpr_srcset(options:, params:)
-      srcset = ''
+      srcset = ""
 
       disable_variable_quality = options[:disable_variable_quality] || false
       validate_variable_qualities!(disable_variable_quality)
@@ -170,12 +222,10 @@ module Imgix
       target_ratios = [1, 2, 3, 4, 5]
       quality = params[:q]
 
-      for ratio in target_ratios do
+      target_ratios.each do |ratio|
         params[:dpr] = ratio
 
-        unless disable_variable_quality
-          params[:q] = quality || DPR_QUALITY[ratio]
-        end
+        params[:q] = quality || DPR_QUALITY[ratio] unless disable_variable_quality
 
         srcset += "#{to_url(params)} #{ratio}x,\n"
       end
@@ -184,34 +234,28 @@ module Imgix
     end
 
     def validate_width_tolerance!(width_tolerance)
-      width_increment_error = 'error: `width_tolerance` must be a positive `Numeric` value'
+      width_increment_error = "error: `width_tolerance` must be a positive `Numeric` value"
 
-      if !width_tolerance.is_a?(Numeric) || width_tolerance <= 0
-        raise ArgumentError, width_increment_error
-      end
+      raise ArgumentError, width_increment_error if !width_tolerance.is_a?(Numeric) || width_tolerance <= 0
     end
 
     def validate_widths!(widths)
-      widths_error = 'error: `widths` must be an array of positive `Numeric` values'
+      widths_error = "error: `widths` must be an array of positive `Numeric` values"
       raise ArgumentError, widths_error unless widths.is_a?(Array)
 
       all_positive_integers = widths.all? { |i| i.is_a?(Integer) && i > 0 }
       raise ArgumentError, widths_error unless all_positive_integers
     end
 
-    def validate_range!(min_srcset, max_srcset)
-      range_numeric_error = 'error: `min_width` and `max_width` must be positive `Numeric` values'
-      unless min_srcset.is_a?(Numeric) && max_srcset.is_a?(Numeric)
-        raise ArgumentError, range_numeric_error
-      end
+    def validate_range!(min_width, max_width)
+      range_numeric_error = "error: `min_width` and `max_width` must be positive `Numeric` values"
+      raise ArgumentError, range_numeric_error unless min_width.is_a?(Numeric) && max_width.is_a?(Numeric)
 
-      unless min_srcset > 0 && max_srcset > 0
-        raise ArgumentError, range_numeric_error
-      end
+      raise ArgumentError, range_numeric_error unless min_width > 0 && max_width > 0
     end
 
     def validate_variable_qualities!(disable_quality)
-      disable_quality_error = 'error: `disable_quality` must be a Boolean value'
+      disable_quality_error = "error: `disable_quality` must be a Boolean value"
       unless disable_quality.is_a?(TrueClass) || disable_quality.is_a?(FalseClass)
         raise ArgumentError, disable_quality_error
       end

data/lib/imgix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Imgix
-  VERSION = '3.3.1'
+  VERSION = "4.0.3"
 end

data/script/bench_path.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH << 'lib'
+require 'imgix'
+require 'benchmark/ips'
+
+client = Imgix::Client.new(domain: 'domain.com', secure_url_token: 'token')
+
+Benchmark.ips do |x|
+  x.report('Imgix::Path#initialize') do
+    client.path("/img.jpg")
+  end
+end

data/script/bench_to_url.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH << 'lib'
+require 'imgix'
+require 'benchmark/ips'
+
+client = Imgix::Client.new(domain: 'domain.com', secure_url_token: 'token')
+path = client.path("/img.jpg")
+
+Benchmark.ips do |x|
+  x.report('Imgix::Path#to_url') do
+    path.to_url({ auto: 'compress,format', fit: 'crop', crop: 'top', w: 590, h: 332 })
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 4.0.3
 platform: ruby
 authors:
 - Kelly Sutton
@@ -10,39 +10,11 @@ authors:
 - Antony Denyer
 - Paul Straw
 - Sherwin Heydarbeygi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2021-05-05 00:00:00.000000000 Z
+dependencies: []
 description: Easily create and sign imgix URLs.
 email:
 - kelly@imgix.com
@@ -55,13 +27,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/ISSUE_TEMPLATE/question.md"
-- ".github/pull_request_template.md"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
+- ".vscode/tasks.json"
 - CHANGELOG.md
 - Contributing.markdown
 - Gemfile
@@ -71,25 +40,19 @@ files:
 - imgix.gemspec
 - lib/imgix.rb
 - lib/imgix/client.rb
-- lib/imgix/param_helpers.rb
 - lib/imgix/path.rb
 - lib/imgix/version.rb
-- test/test_helper.rb
-- test/units/domains_test.rb
-- test/units/param_helpers_test.rb
-- test/units/path_test.rb
-- test/units/purge_test.rb
-- test/units/srcset_test.rb
-- test/units/url_test.rb
+- script/bench_path.rb
+- script/bench_to_url.rb
 homepage: https://github.com/imgix/imgix-rb
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/imgix/imgix-rb/issues
   changelog_uri: https://github.com/imgix/imgix-rb/blob/main/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/imgix/3.3.1
-  source_code_uri: https://github.com/imgix/imgix-rb/tree/3.3.1
-post_install_message: 
+  documentation_uri: https://www.rubydoc.info/gems/imgix/4.0.3
+  source_code_uri: https://github.com/imgix/imgix-rb/tree/4.0.3
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,15 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Official Ruby Gem for easily creating and signing imgix URLs.
-test_files:
-- test/test_helper.rb
-- test/units/domains_test.rb
-- test/units/param_helpers_test.rb
-- test/units/path_test.rb
-- test/units/purge_test.rb
-- test/units/srcset_test.rb
-- test/units/url_test.rb
+test_files: []