imgix 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c260521282fd6b24c05cf774caaf4b140fef9b5a
-  data.tar.gz: d7b53e8cce58a50020eeba7d9c4ad6aa556dfbb5
+  metadata.gz: 93aa8838354b1565c1691c817c4ed212d76b3222
+  data.tar.gz: bc28c0311f08510f4fc4ff96c73774b59d83e59f
 SHA512:
-  metadata.gz: 33ff8d7ea4e778dcea4ade90283896b034c40b9d6cbd613920ec2712390b925d39041f996b3d44698a76dd279b829ab1d0a55e86e05dd57fbb2a417a03cf3b7b
-  data.tar.gz: 87ab1ed154e7ea3bfa69538a8904d3f8e9145f3cfa9175b3db60dc9855a20ca0f9845663be9a12eadcf340e8bf3cd1e29de630fa6561c092a0e7e9700a493b22
+  metadata.gz: e7e492f9c63a641a6c2dc6f3f86ef96008c965187ce5439448e878d37a0b825871672447b8f113eba1137c97353a358e7cc6a3be68b8720c5a37472bc5f4515f
+  data.tar.gz: b2b3799e866a64680842a6193d5ca1e0794ff5d918052c732bfe704de63bc9bb5b29a7e6f4f608fc5642344e01ee38b22990951273e16402ccd98022a1906252

data/.travis.yml

@@ -1,16 +1,6 @@
+dist: trusty
 language: ruby
 bundler_args: --without development
-before_install:
-  # Extracts the ruby version number
-  - RUBY_VERS="$(bc -l<<<$(ruby -v | cut -d' ' -f 2 | cut -d'.' -f 1,2))"
-  # Bundler 2.0 requires at least ruby vers 2.3.0
-  - LATEST_VERS=2.3
-  # Based on a given job's ruby version, install either
-  # Bundler 2.x or 1.17
-  - if (( $(echo "$RUBY_VERS >= $LATEST_VERS" | bc -l) ));
-      then echo $(gem install bundler); 
-      else echo $(gem install bundler -v '< 2'); 
-    fi
 rvm:
   - 2.3.0
   - 2.2.4

data/CHANGELOG.md

@@ -3,7 +3,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [3.1.0](https://github.com/imgix/imgix-rb/compare/2.1.0...3.1.0) - July 28, 2019
+## [3.1.1](https://github.com/imgix/imgix-rb/compare/3.1.0...3.1.1) - July 28, 2019
+
+* fix: include dpr parameter when generating a DPR srcset ([#48](https://github.com/imgix/imgix-rb/pull/48))
+* ci(travis): change build dist to trusty and remove bundler script ([#49](https://github.com/imgix/imgix-rb/pull/49))
+
+## [3.1.0](https://github.com/imgix/imgix-rb/compare/3.0.0...3.1.0) - July 28, 2019
 
 * feat: add srcset generation ([#47](https://github.com/imgix/imgix-rb/pull/47))
 

data/README.md

@@ -68,23 +68,23 @@ https://your-subdomain.imgix.net/images/demo.png?w=7400&s=a5dd7dda1dbac613f0475f
 https://your-subdomain.imgix.net/images/demo.png?w=8192&s=9fbd257c53e770e345ce3412b64a3452 8192w
 ```
 
-In cases where enough information is provided about an image's dimensions, `to_srcset` will instead build a `srcset` that will allow for an image to be served at different resolutions. The parameters taken into consideration when determining if an image is fixed-width are `w`, `h`, and `ar`. By invoking `to_srcset` with either a width **or** the height and aspect ratio provided, a different `srcset` will be generated for a fixed-size image instead.
+In cases where enough information is provided about an image's dimensions, `to_srcset` will instead build a `srcset` that will allow for an image to be served at different resolutions. The parameters taken into consideration when determining if an image is fixed-width are `w`, `h`, and `ar`. By invoking `to_srcset` with either a width **or** the height and aspect ratio (along with `fit=crop`, typically) provided, a different `srcset` will be generated for a fixed-size image instead.
 
 ```rb
-client = Imgix::Client.new(host: 'your-subdomain.imgix.net', secure_url_token: 'your-token')
+client = Imgix::Client.new(host: 'your-subdomain.imgix.net', secure_url_token: 'your-token', include_library_param: false)
 path = client.path('/images/demo.png')
 
-srcset = path.to_srcset(h:800, ar:'3:2')
+srcset = path.to_srcset(h:800, ar:'3:2', fit:'crop')
 ```
 
 Will produce the following attribute value:
 
 ```html
-https://your-subdomain.imgix.net/images/demo.png?h=800&ar=3%3A2&s=be8c153bb9ed0dd152e846414a8fdc86 1x,
-https://your-subdomain.imgix.net/images/demo.png?h=800&ar=3%3A2&s=be8c153bb9ed0dd152e846414a8fdc86 2x,
-https://your-subdomain.imgix.net/images/demo.png?h=800&ar=3%3A2&s=be8c153bb9ed0dd152e846414a8fdc86 3x,
-https://your-subdomain.imgix.net/images/demo.png?h=800&ar=3%3A2&s=be8c153bb9ed0dd152e846414a8fdc86 4x,
-https://your-subdomain.imgix.net/images/demo.png?h=800&ar=3%3A2&s=be8c153bb9ed0dd152e846414a8fdc86 5x
+https://your-subdomain.imgix.net/images/demo.png?h=800&ar=3%3A2&fit=crop&dpr=1&s=f97f2dccf85beac33a3824b57ef4ddc6 1x,
+https://your-subdomain.imgix.net/images/demo.png?h=800&ar=3%3A2&fit=crop&dpr=2&s=e1727167fef53cdb0a89dd66b8672410 2x,
+https://your-subdomain.imgix.net/images/demo.png?h=800&ar=3%3A2&fit=crop&dpr=3&s=7718db8457345419c30214f1d1a3a5d3 3x,
+https://your-subdomain.imgix.net/images/demo.png?h=800&ar=3%3A2&fit=crop&dpr=4&s=000c50a7f97ccdbb9bb2f00bc5241ed4 4x,
+https://your-subdomain.imgix.net/images/demo.png?h=800&ar=3%3A2&fit=crop&dpr=5&s=970b6fc12a410f3dd2959674dd1f4120 5x
 ```
 
 For more information to better understand `srcset`, we highly recommend [Eric Portis' "Srcset and sizes" article](https://ericportis.com/posts/2014/srcset-sizes/) which goes into depth about the subject.

data/lib/imgix/path.rb

@@ -85,16 +85,21 @@ module Imgix
     end
 
     def to_srcset(params = {})
+      prev_options = @options.dup
       @options.merge!(params)
+
       width = @options['w'.to_sym]
       height = @options['h'.to_sym]
       aspect_ratio = @options['ar'.to_sym]
 
       if ((width) || (height && aspect_ratio))
-        build_dpr_srcset(@options)
+        srcset = build_dpr_srcset(@options)
       else
-        build_srcset_pairs(@options)
+        srcset = build_srcset_pairs(@options)
       end
+
+      @options = prev_options
+      return srcset
     end
     
     private
@@ -123,24 +128,24 @@ module Imgix
       query.length > 0
     end
 
-    def build_srcset_pairs(params = {})
+    def build_srcset_pairs(params)
       srcset = ''
+
       for width in @target_widths do
-        currentParams = params || {}
-        currentParams['w'] = width
-        srcset += "#{to_url(currentParams)} #{width}w,\n"
+        params['w'.to_sym] = width
+        srcset += "#{to_url(params)} #{width}w,\n"
       end
 
       return srcset[0..-3]
     end
 
-    def build_dpr_srcset(params = {})
+    def build_dpr_srcset(params)
       srcset = ''
       target_ratios = [1,2,3,4,5]
-      url = to_url(params)
 
       for ratio in target_ratios do
-        srcset += "#{url} #{ratio}x,\n"
+        params['dpr'.to_sym] = ratio
+        srcset += "#{to_url(params)} #{ratio}x,\n"
       end
 
       return srcset[0..-3]

data/lib/imgix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Imgix
-  VERSION = '3.1.0'
+  VERSION = '3.1.1'
 end

data/test/units/srcset_test.rb

@@ -9,6 +9,21 @@ module SrcsetTest
             assert_equal expected_number_of_pairs, srcset.split(',').length
         end
         
+        def test_srcset_pair_values
+            resolutions = [100, 116, 134, 156, 182, 210, 244, 282,
+                328, 380, 442, 512, 594, 688, 798, 926,
+                1074, 1246, 1446, 1678, 1946, 2258, 2618,
+                3038, 3524, 4088, 4742, 5500, 6380, 7400, 8192]
+            srcset = path.to_srcset()
+            srclist = srcset.split(',').map { |srcset_split|
+                srcset_split.split(' ')[1].to_i
+            }
+
+            for i in 0..srclist.length-1 do
+                assert_equal(srclist[i], resolutions[i])
+            end
+        end
+        
         private
             def path
                 @client ||= Imgix::Client.new(host: 'testing.imgix.net', secure_url_token: 'MYT0KEN', include_library_param: false).path('image.jpg')
@@ -26,14 +41,29 @@ module SrcsetTest
             }
         end
 
+        def test_srcset_has_dpr_params
+            i = 1
+            srcset.split(',').map { |srcset_split|
+                src = srcset_split.split(' ')[0]
+                assert_includes src, "dpr=#{i}"
+                i += 1
+            }
+        end
+
         def test_srcset_signs_urls
-            expected_signature = 'b95cfd915f4a198442bff4ce5befe5b8'
+            srcset.split(',').map { |srcset_split|
+                src = srcset_split.split(' ')[0]
+                assert_includes src, 's='
 
-            srcset.split(',').map { |src|
-                url = src.split(' ')[0]
-                assert_includes url, "s="
+                # parses out all parameters except for 's=...'
+                params = src[src.index('?')..src.index('s=')-2]
 
-                generated_signature = url.slice(url.index("s=")+2, url.length)
+                # parses out the 's=...' parameter
+                generated_signature = src.slice(src.index('s=')+2, src.length)
+
+                signature_base = 'MYT0KEN' + '/image.jpg' + params;
+                expected_signature = Digest::MD5.hexdigest(signature_base)
+                
                 assert_equal expected_signature, generated_signature
             }
         end
@@ -50,6 +80,20 @@ module SrcsetTest
             assert_equal expected_number_of_pairs, srcset.split(',').length
         end
 
+        def test_srcset_pair_values
+            resolutions = [100, 116, 134, 156, 182, 210, 244, 282,
+                328, 380, 442, 512, 594, 688, 798, 926,
+                1074, 1246, 1446, 1678, 1946, 2258, 2618,
+                3038, 3524, 4088, 4742, 5500, 6380, 7400, 8192]
+            srclist = srcset.split(',').map { |srcset_split|
+                srcset_split.split(' ')[1].to_i
+            }
+
+            for i in 0..srclist.length-1 do
+                assert_equal(srclist[i], resolutions[i])
+            end
+        end
+
         def test_srcset_respects_height_parameter
             srcset.split(',').map { |src|
                 assert_includes src, 'h='
@@ -90,8 +134,8 @@ module SrcsetTest
                 assert_includes src, 's='
 
                 # parses out all parameters except for 's=...'
-                params = src.slice(src.index('?'), src.length)
-                params = params.slice(0, params.index('s=')-1)
+                params = src[src.index('?')..src.index('s=')-2]
+
                 # parses out the 's=...' parameter
                 generated_signature = src.slice(src.index('s=')+2, src.length)
 
@@ -119,14 +163,29 @@ module SrcsetTest
             }
         end
 
+        def test_srcset_has_dpr_params
+            i = 1
+            srcset.split(',').map { |srcset_split|
+                src = srcset_split.split(' ')[0]
+                assert_includes src, "dpr=#{i}"
+                i += 1
+            }
+        end
+
         def test_srcset_signs_urls
-            expected_signature = 'fb081a45c449b28f69e012d474943df3'
+            srcset.split(',').map { |srcset_split|
+                src = srcset_split.split(' ')[0]
+                assert_includes src, 's='
 
-            srcset.split(',').map { |src|
-                url = src.split(' ')[0]
-                assert_includes url, "s="
+                # parses out all parameters except for 's=...'
+                params = src[src.index('?')..src.index('s=')-2]
 
-                generated_signature = url.slice(url.index("s=")+2, url.length)
+                # parses out the 's=...' parameter
+                generated_signature = src.slice(src.index('s=')+2, src.length)
+
+                signature_base = 'MYT0KEN' + '/image.jpg' + params;
+                expected_signature = Digest::MD5.hexdigest(signature_base)
+                
                 assert_equal expected_signature, generated_signature
             }
         end
@@ -143,6 +202,20 @@ module SrcsetTest
             assert_equal expected_number_of_pairs, srcset.split(',').length
         end
 
+        def test_srcset_pair_values
+            resolutions = [100, 116, 134, 156, 182, 210, 244, 282,
+                328, 380, 442, 512, 594, 688, 798, 926,
+                1074, 1246, 1446, 1678, 1946, 2258, 2618,
+                3038, 3524, 4088, 4742, 5500, 6380, 7400, 8192]
+            srclist = srcset.split(',').map { |srcset_split|
+                srcset_split.split(' ')[1].to_i
+            }
+
+            for i in 0..srclist.length-1 do
+                assert_equal(srclist[i], resolutions[i])
+            end
+        end
+
         def test_srcset_within_bounds
             min, *max = srcset.split(',')
 
@@ -177,8 +250,8 @@ module SrcsetTest
                 assert_includes src, 's='
 
                 # parses out all parameters except for 's=...'
-                params = src.slice(src.index('?'), src.length)
-                params = params.slice(0, params.index('s=')-1)
+                params = src[src.index('?')..src.index('s=')-2]
+
                 # parses out the 's=...' parameter
                 generated_signature = src.slice(src.index('s=')+2, src.length)
 
@@ -206,14 +279,29 @@ module SrcsetTest
             }
         end
 
+        def test_srcset_has_dpr_params
+            i = 1
+            srcset.split(',').map { |srcset_split|
+                src = srcset_split.split(' ')[0]
+                assert_includes src, "dpr=#{i}"
+                i += 1
+            }
+        end
+
         def test_srcset_signs_urls
-            expected_signature = '84db8cb226483fc0130b4fb58e1e6ff2'
+            srcset.split(',').map { |srcset_split|
+                src = srcset_split.split(' ')[0]
+                assert_includes src, 's='
 
-            srcset.split(',').map { |src|
-                url = src.split(' ')[0]
-                assert_includes url, "s="
+                # parses out all parameters except for 's=...'
+                params = src[src.index('?')..src.index('s=')-2]
+
+                # parses out the 's=...' parameter
+                generated_signature = src.slice(src.index('s=')+2, src.length)
 
-                generated_signature = url.slice(url.index("s=")+2, url.length)
+                signature_base = 'MYT0KEN' + '/image.jpg' + params;
+                expected_signature = Digest::MD5.hexdigest(signature_base)
+                
                 assert_equal expected_signature, generated_signature
             }
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Kelly Sutton
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2019-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable