imgix 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d45f1a9130411b2b890ad779f5e67ffd506958d0c939d79e3eac2e7a1ff3a7c0
-  data.tar.gz: 9a1a729003bdb13dd0b390af5afe60b16e95691aa49f483fa6b37c1c0c27332f
+  metadata.gz: b593ef71fdd4683f9af895b093f631c8ee57c0e5e1008dd82ece781d422d1b36
+  data.tar.gz: eb75567f9424d0b898e7773fac412d0500d24350e4a6d73775babb739f01d971
 SHA512:
-  metadata.gz: 470a6ff91572f79a5d93d2040c5ce50d035e379739aa207e2af4b3a45d0c510042276d42c73839bbc154fc4d4112d913005cccfecdcee930ed36098a06d36055
-  data.tar.gz: 390c08cee470af444bc95140758fe39e108270df0e2ca6d66ac2b3e42c59665c7786ff99965652758a246b19a6486f12e19185528c8dad3c8bcc2fca5a93cd18
+  metadata.gz: '0389f0633ffba93ba0e5eb3e69dbf7017462ade823648ce3c490451ea0c5bd6c30a9a6c95b8e03f3111eb27cd6bdc4b766eb279b7c9c95f9feae77c6751c6b39'
+  data.tar.gz: c2033581fb3e629ff440c3aada007804872dc2d5a9f495006a47dded1ad532d043b9a83bc8e12ae3bc9ddb4874c3bc6802e5ac5f2677a8182cee4e6c43e6267e

data/.travis.yml

@@ -2,11 +2,8 @@ dist: trusty
 language: ruby
 bundler_args: --without development
 rvm:
-  - 2.7.0
-  - 2.6.3
-  - 2.3.0
-  - 2.2.4
-  - 2.1.8
+  - 2.7
+  - 2.6
   - jruby-9.2.11.0
 
 jobs:
@@ -15,9 +12,8 @@ jobs:
 
   include:
     - name: Rubinius
-      rvm: rbx-3.107
+      rvm: rbx-3
       dist: trusty
   
   allow_failures:
     - name: Rubinius
- 

data/.vscode/tasks.json

@@ -0,0 +1,29 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"label": "rake: test",
+			"type": "shell",
+			"group":{
+				"kind": "test",
+				"isDefault": true
+			},
+			"problemMatcher": {
+				"owner": "ruby",
+				"fileLocation": ["relative", "${workspaceFolder}"],
+				"pattern": [
+						{
+							"regexp": "^([^:]+: .+)",
+							"message": 1
+						},
+						{
+							"regexp": "^    ([^:]+):(\\d+)",
+							"file": 1,
+							"line": 2
+						}
+				]
+			},
+			"command": "bundle exec rake test"
+		}
+	]
+}

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [4.0.2](https://github.com/imgix/imgix-rb/compare/4.0.1...4.0.2) - April 22, 2021
+
+* fix(path): correctly encode reserved chars ([#108](https://github.com/imgix/imgix-rb/pull/108))
+* test: add benchmark script for Imgix::Path#to_url ([4b00c4b](https://github.com/imgix/imgix-rb/commit/4b00c4b6d27b87787464438b36954b9c166096eb))
+* perf: avoid calculating path_and_params twice ([#109](https://github.com/imgix/imgix-rb/pull/109))
+* ci: use major version only for Rubinius 3 ([921e41a](https://github.com/imgix/imgix-rb/commit/921e41ac7789a55c78b42d60ac99cc0b641a69fd))
+* ci: use optimistic versioning ([#107](https://github.com/imgix/imgix-rb/pull/107))
+* ci: remove support for ruby version <2.5 ([#106](https://github.com/imgix/imgix-rb/pull/106))
+* perf: precompute DEFAULT_TARGET_WIDTHS to avoid repeating on Path.new ([#105](https://github.com/imgix/imgix-rb/pull/105))
+
 ## [4.0.1](https://github.com/imgix/imgix-rb/compare/4.0.0...4.0.1) - March 24, 2021
 
 * fix: dpr srcset when only h param ([#101](https://github.com/imgix/imgix-rb/pull/101))

data/Gemfile

@@ -8,4 +8,7 @@ gemspec
 gem 'rake'
 gem 'json'
 gem 'minitest'
+gem 'minitest-reporters'
 gem 'webmock'
+gem 'benchmark-ips'
+

data/lib/imgix.rb

@@ -39,6 +39,7 @@ module Imgix
     resolutions.push(max_size)
     return resolutions
   }
+  DEFAULT_TARGET_WIDTHS = TARGET_WIDTHS.call(DEFAULT_WIDTH_TOLERANCE, MIN_WIDTH, MAX_WIDTH).freeze
 
   # hash of default quality parameter values mapped  by each dpr srcset entry
   DPR_QUALITY = {

data/lib/imgix/path.rb

@@ -12,20 +12,18 @@ module Imgix
       @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
@@ -130,12 +128,46 @@ module Imgix
 
     private
 
-    def signature
-      Digest::MD5.hexdigest(@secure_url_token + path_and_params)
+    # 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
+
+    # URL encode the entire path
+    def encode_URI_Component(path)
+      return "/" + CGI.escape(path)
+    end
+
+    # 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(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
@@ -170,7 +202,7 @@ 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
 
       srcset_widths.each do |width|

data/lib/imgix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Imgix
-  VERSION = "4.0.1"
+  VERSION = "4.0.2"
 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: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Kelly Sutton
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies: []
 description: Easily create and sign imgix URLs.
 email:
@@ -30,6 +30,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".vscode/tasks.json"
 - CHANGELOG.md
 - Contributing.markdown
 - Gemfile
@@ -41,14 +42,16 @@ files:
 - lib/imgix/client.rb
 - lib/imgix/path.rb
 - lib/imgix/version.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/4.0.1
-  source_code_uri: https://github.com/imgix/imgix-rb/tree/4.0.1
+  documentation_uri: https://www.rubydoc.info/gems/imgix/4.0.2
+  source_code_uri: https://github.com/imgix/imgix-rb/tree/4.0.2
 post_install_message:
 rdoc_options: []
 require_paths: