imgix 3.3.1 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1af83e026e72b6ce6bfcfdf1169add23c12cbec68a7d7fbe03243150c832b34b
-  data.tar.gz: 3a7e0d57c3f65b75327e226918370771f7bb579284228de9e6de77d694d4fadc
+  metadata.gz: 6ab4780027f2b1f8835f0fe5ad177afbb1ee954f95bd4fa76e92986bb8a31264
+  data.tar.gz: 5c1c49734258dd0c3c99cffa3564d99e140cfede4a6a117a6d3433902a019413
 SHA512:
-  metadata.gz: 0a68e202aaa183a4974d9c15a20e97f404269879da403cb7a949c04dd5ba3053e4b4802aa2a7006826f357a4268f87fd20d14971034e598d792e18a5cd2b322d
-  data.tar.gz: e1f068f01a5cd8cac1b959bd16f9e2d586a72278a6b4be844a822c74a41c7b7e110471c36a4bf156b6ec6c17cbcc5e425ebdf40373b2424ce3360bd1ada391d2
+  metadata.gz: a12613119005a7e9cf84d054b25c459aa6e6cc34e3e9001c11b55e72c3f76ca1566bc4e6737e1891e1445513ae1eb0b8cc247497312937a1a875740b7064afbf
+  data.tar.gz: e9de151e47fa1c555d2199d21539dcb52c27b5879dcb8ece7c822fc96c81f4a7e204a47d73602e349d38728defc38256759d1fb8ad0267369be46d168e0e770e

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -2,9 +2,8 @@ dist: trusty
 language: ruby
 bundler_args: --without development
 rvm:
-  - 2.3.0
-  - 2.2.4
-  - 2.1.8
+  - 2.7
+  - 2.6
   - jruby-9.2.11.0
 
 jobs:
@@ -13,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,36 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [4.0.3](https://github.com/imgix/imgix-rb/compare/4.0.2...4.0.3) - May 05, 2021
+
+* fix: encode web proxy paths using url_encode ([#111](https://github.com/imgix/imgix-rb/pull/111))
+
+## [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))
+* docs: update travis badge to point to travis-ci.com ([#99](https://github.com/imgix/imgix-rb/pull/99))
+* docs: fixed typo w/ srcset min/max widths ([#97](https://github.com/imgix/imgix-rb/pull/97))
+
+## [4.0.0](https://github.com/imgix/imgix-rb/compare/3.4.0...4.0.0) - August 26, 2020
+
+* deprecate: host-usage, param_helpers, and prefix-1-ary ([#91](https://github.com/imgix/imgix-rb/pull/91))
+* fix: update purge operation api keys ([#93](https://github.com/imgix/imgix-rb/pull/93))
+
+## [3.4.0](https://github.com/imgix/imgix-rb/compare/3.3.1...3.4.0) - August 12, 2020
+
+* fix: deprecate api key versions ([#87](https://github.com/imgix/imgix-rb/pull/87))
+* docs(readme): deprecation notice for pre-4.0 api keys ([#88](https://github.com/imgix/imgix-rb/pull/88))
+
 ## [3.3.1](https://github.com/imgix/imgix-rb/compare/3.3.0...3.3.1) - July 27, 2020
 
 * fix: ensure host is initialized ([#82](https://github.com/imgix/imgix-rb/pull/82))

data/Gemfile

@@ -1,9 +1,14 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in imgix.gemspec
 gemspec
 
 gem 'rake'
+gem 'json'
 gem 'minitest'
+gem 'minitest-reporters'
 gem 'webmock'
-gem 'addressable'
+gem 'benchmark-ips'
+

data/README.md

@@ -4,9 +4,10 @@
 `imgix-rb` is a client library for generating image URLs with [imgix](https://www.imgix.com/). It is tested under Ruby versions `2.3.0`, `2.2.4`, `2.1.8`, `jruby-9.2.11.0`, and `rbx-3.107`.
 
 [![Gem Version](https://img.shields.io/gem/v/imgix.svg)](https://rubygems.org/gems/imgix)
-[![Build Status](https://travis-ci.org/imgix/imgix-rb.svg?branch=main)](https://travis-ci.org/imgix/imgix-rb)
+[![Build Status](https://travis-ci.com/imgix/imgix-rb.svg?branch=main)](https://travis-ci.com/imgix/imgix-rb)
 ![Downloads](https://img.shields.io/gem/dt/imgix)
 [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/imgix/imgix-rb/blob/main/LICENSE)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fimgix%2Fimgix-rb.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fimgix%2Fimgix-rb?ref=badge_shield)
 
 ---
 <!-- /ix-docs-ignore -->
@@ -14,16 +15,16 @@
 - [Installation](#installation)
 - [Usage](#usage)
 - [Srcset Generation](#srcset-generation)
-  - [Fixed image rendering](#fixed-image-rendering)
-  - [Custom Widths](#custom-widths)
-  - [Width Tolerance](#width-tolerance)
-  - [Minimum and Maximum Width Ranges](#minimum-and-maximum-width-ranges)
-  - [Variable Qualities](#variable-qualities)
-- [Multiple Parameters](#multiple-parameters)
+    * [Fixed image rendering](#fixed-image-rendering)
+    * [Custom Widths](#custom-widths)
+    * [Width Tolerance](#width-tolerance)
+    * [Minimum and Maximum Width Ranges](#minimum-and-maximum-width-ranges)
+    * [Variable Qualities](#variable-qualities)
 - [Purge Cache](#purge-cache)
 - [URL encoding and signed imgix URLs](#url-encoding-and-signed-imgix-urls)
 - [What is the `ixlib` param on every request?](#what-is-the-ixlib-param-on-every-request)
 - [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
@@ -48,36 +49,13 @@ Initialize a client with a `:domain` and your `:secure_url_token`. By default, H
 
 Call `Imgix::Client#path` with the resource path to get an `Imgix::Path` object back. You can then manipulate the path parameters, and call `Imgix#Path#to_url` when you're done.
 
-``` ruby
+```rb
 client = Imgix::Client.new(domain: 'your-subdomain.imgix.net', secure_url_token: 'your-token')
 
 client.path('/images/demo.png').to_url(w: 200)
 #=> https://your-subdomain.imgix.net/images/demo.png?w=200&s=2eadddacaa9bba4b88900d245f03f51e
-
-# OR
-path = client.path('/images/demo.png')
-path.width = 200
-path.to_url
-
-# OR
-client.path('/images/demo.png').width(200).height(300).to_url
-
-# Some other tricks
-path.defaults.width(300).to_url # Resets parameters
-path.rect(x: 0, y: 50, width: 200, height: 300).to_url # Rect helper
-```
-
-**Deprecation Notice:** Usage of `:host` has been deprecated and will become invalid in the next major release.
-
-In the previous version, `:host` can be used to specify a domain for an `Imgix::Client` like so:
-
-```ruby
-Imgix::Client.new(host: 'demo.imgix.net', secure_url_token: 'token')
 ```
 
-Code using `:host` like the above will continue to work until the next major release. While using `:host` will remain valid until the next major release, its usage will result in a deprecation warning. In order to resolve these deprecation warnings before upgrading to the new release, use `:domain` instead of `:host`.
-
-
 ## Srcset Generation
 
 The imgix gem allows for generation of custom `srcset` attributes, which can be invoked through `Imgix::Path#to_srcset`. By default, the `srcset` generated will allow for responsive size switching by building a list of image-width mappings.
@@ -102,7 +80,7 @@ https://your-subdomain.imgix.net/images/demo.png?w=8192&s=9fbd257c53e770e345ce34
 
 ### Fixed image rendering
 
-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.
+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` or `h`. By invoking `to_srcset` with either a width **or** height provided, a different `srcset` will be generated for a fixed-size image instead.
 
 ```rb
 client = Imgix::Client.new(domain: 'your-subdomain.imgix.net', secure_url_token: 'your-token', include_library_param: false)
@@ -167,11 +145,11 @@ https://testing.imgix.net/image.jpg?w=8192 8192w
 
 ### Minimum and Maximum Width Ranges
 
-If the exact number of minimum/maximum physical pixels that an image will need to be rendered at is known, a user can specify them by passing an integer via `min_srcset` and/or `max_srcset` to the `options` keyword parameters:
+If the exact number of minimum/maximum physical pixels that an image will need to be rendered at is known, a user can specify them by passing an integer via `min_width` and/or `max_width` to the `options` keyword parameters:
 
 ```rb
 client = Imgix::Client.new(domain: 'testing.imgix.net', include_library_param: false)
-client.path('image.jpg').to_srcset(options: { min_srcset: 500, max_srcset: 2000 })
+client.path('image.jpg').to_srcset(options: { min_width: 500, max_width: 2000 })
 ```
 
 Will result in a smaller, more tailored srcset.
@@ -190,7 +168,7 @@ https://testing.imgix.net/image.jpg?w=1902 1902w,
 https://testing.imgix.net/image.jpg?w=2000 2000w
 ```
 
-Remember that browsers will apply a device pixel ratio as a multiplier when selecting which image to download from a `srcset`. For example, even if you know your image will render no larger than 1000px, specifying `options: { max_srcset: 1000 }` will give your users with DPR higher than 1 no choice but to download and render a low-resolution version of the image. Therefore, it is vital to factor in any potential differences when choosing a minimum or maximum range.
+Remember that browsers will apply a device pixel ratio as a multiplier when selecting which image to download from a `srcset`. For example, even if you know your image will render no larger than 1000px, specifying `options: { max_width: 1000 }` will give your users with DPR higher than 1 no choice but to download and render a low-resolution version of the image. Therefore, it is vital to factor in any potential differences when choosing a minimum or maximum range.
 
 Also please note that according to the [imgix API](https://docs.imgix.com/apis/url/size/w), the maximum renderable image width is 8192 pixels.
 
@@ -218,19 +196,9 @@ https://testing.imgix.net/image.jpg?w=100&dpr=4&q=23 4x,
 https://testing.imgix.net/image.jpg?w=100&dpr=5&q=20 5x
 ```
 
-## Multiple Parameters
-
-When the imgix api requires multiple parameters you have to use the method rather than an accessor.
-
-For example to use the noise reduction:
-
-``` ruby
-path.noise_reduction(50,50)
-```
-
 ## Purge Cache
 
-If you need to remove or update an image on imgix, you can purge it from our cache by initializing a client with your api_key, then calling Imgix::Client#purge with the resource path.
+If you need to remove or update an image on imgix, you can purge it from our cache by initializing a client with your [API key](http://dashboard.imgix.com/api-keys), then calling `Imgix::Client#purge` with the resource path.
 
 ```ruby
 client = Imgix::Client.new(domain: 'your-subdomain.imgix.net', api_key: 'your-key')
@@ -256,3 +224,6 @@ client = Imgix::Client.new(domain: 'your-subdomain.imgix.net', include_library_p
 ## Contributing
 
 See the [contributing guide](Contributing.markdown).
+
+## License
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fimgix%2Fimgix-rb.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fimgix%2Fimgix-rb?ref=badge_large)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'

data/imgix.gemspec

@@ -1,31 +1,28 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'imgix/version'
+# frozen_string_literal: true
+
+require_relative "lib/imgix/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'imgix'
+  spec.name          = "imgix"
   spec.version       = Imgix::VERSION
-  spec.authors       = ['Kelly Sutton', 'Sam Soffes', 'Ryan LeFevre', 'Antony Denyer', 'Paul Straw', 'Sherwin Heydarbeygi']
-  spec.email         = ['kelly@imgix.com', 'sam@soff.es', 'ryan@layervault.com', 'email@antonydenyer.co.uk', 'paul@imgix.com', 'sherwin@imgix.com']
-  spec.description   = 'Easily create and sign imgix URLs.'
-  spec.summary       = 'Official Ruby Gem for easily creating and signing imgix URLs.'
-  spec.homepage      = 'https://github.com/imgix/imgix-rb'
-  spec.license       = 'MIT'
+  spec.authors       = ["Kelly Sutton", "Sam Soffes", "Ryan LeFevre", "Antony Denyer", "Paul Straw", "Sherwin Heydarbeygi"]
+  spec.email         = ["kelly@imgix.com", "sam@soff.es", "ryan@layervault.com", "email@antonydenyer.co.uk", "paul@imgix.com", "sherwin@imgix.com"]
+  spec.description   = "Easily create and sign imgix URLs."
+  spec.summary       = "Official Ruby Gem for easily creating and signing imgix URLs."
+  spec.homepage      = "https://github.com/imgix/imgix-rb"
+  spec.license       = "MIT"
 
   spec.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/#{spec.version}",
-    'source_code_uri'   => "https://github.com/imgix/imgix-rb/tree/#{spec.version}"
+    "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/#{spec.version}",
+    "source_code_uri" => "https://github.com/imgix/imgix-rb/tree/#{spec.version}"
   }
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|.github)/}) }
+  end
 
-  spec.required_ruby_version = '>= 1.9.0'
-  spec.add_dependency 'addressable'
-  spec.add_development_dependency 'webmock'
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 1.9.0"
 end

data/lib/imgix.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'imgix/version'
-require 'imgix/client'
-require 'imgix/path'
+require "imgix/version"
+require "imgix/client"
+require "imgix/path"
 
 module Imgix
   # regex pattern used to determine if a domain is valid
@@ -22,7 +22,7 @@ module Imgix
     increment_percentage = tolerance || DEFAULT_WIDTH_TOLERANCE
 
     unless increment_percentage.is_a?(Numeric) && increment_percentage > 0
-      width_increment_error = 'error: `width_tolerance` must be a positive `Numeric` value'
+      width_increment_error = "error: `width_tolerance` must be a positive `Numeric` value"
       raise ArgumentError, width_increment_error
     end
 
@@ -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/client.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'digest'
-require 'addressable/uri'
-require 'net/http'
-require 'uri'
+require "digest"
+require "net/http"
+require "uri"
+require "json"
 
 module Imgix
   class Client
@@ -11,82 +11,96 @@ module Imgix
 
     def initialize(options = {})
       options = DEFAULTS.merge(options)
-      host, domain = options[:host], options[:domain]
-
-      host_deprecated = "Warning: The identifier `host' has been deprecated and " \
-        "will\nappear as `domain' in the next major version, e.g. " \
-        "`@host'\nbecomes `@domain', `options[:host]' becomes " \
-        "`options[:domain]'.\n"
-
-      if host
-        warn host_deprecated
-        @host = host
-      elsif domain
-        @host = domain
-      else
-        @host = host
-      end
+      @domain = options[:domain]
 
-      validate_host!
+      validate_domain!
 
       @secure_url_token = options[:secure_url_token]
       @api_key = options[:api_key]
       @use_https = options[:use_https]
       @include_library_param = options.fetch(:include_library_param, true)
-      @library = options.fetch(:library_param, 'rb')
+      @library = options.fetch(:library_param, "rb")
       @version = options.fetch(:library_version, Imgix::VERSION)
     end
 
     def path(path)
-      p = Path.new(new_prefix, @secure_url_token, path)
+      p = Path.new(prefix, @secure_url_token, path)
       p.ixlib("#{@library}-#{@version}") if @include_library_param
       p
     end
 
     def purge(path)
-      token_error = 'Authentication token required'
-      raise token_error if @api_key.nil?
-
-      url = new_prefix + path
-      uri = URI.parse('https://api.imgix.com/v2/image/purger')
+      api_key_error = "A valid API key is required to send purge requests"
+      raise api_key_error if @api_key.nil?
 
-      user_agent = { 'User-Agent' => "imgix #{@library}-#{@version}" }
+      endpoint = URI.parse("https://api.imgix.com/api/v1/purge")
+      # Ensure the path has been prefixed with '/'.
+      path = path.start_with?("/") ? path : "/#{path}"
+      url = prefix + path
 
-      req = Net::HTTP::Post.new(uri.path, user_agent)
-      req.basic_auth @api_key, ''
-      req.set_form_data({ url: url })
+      req = create_request(endpoint, url, :json_data_from)
 
-      sock = Net::HTTP.new(uri.host, uri.port)
+      sock = Net::HTTP.new(endpoint.host, endpoint.port)
       sock.use_ssl = true
-      res = sock.start { |http| http.request(req) }
-
-      res
+      sock.start { |http| http.request(req) }
     end
 
-    def prefix(path)
-      msg = "Warning: `Client::prefix' will take zero arguments " \
-        "in the next major version.\n"
-      warn msg
-      new_prefix
+    def prefix
+      "#{@use_https ? 'https' : 'http'}://#{@domain}"
     end
 
-    def new_prefix
-      "#{@use_https ? 'https' : 'http'}://#{@host}"
+    private
+
+    # Create a request object by specifying it's endpoint, resource, and
+    # an optional data_fmt.
+    #
+    # `endpoint` must be a valid URI object
+    # `resource` must be a valid URL designating the resource to be purged
+    # `data_fmt` must be a valid method or Proc object
+    #
+    # Specify a `data_fmt` method when a resource (URL) requires
+    # additional formatting before being included in the request body.
+    # By default, the data format is specified by the `json_data_from`
+    # method.
+    def create_request(endpoint, resource, data_fmt = :json_data_from)
+      req = Net::HTTP::Post.new(endpoint.path)
+      req["Content-Type"] = "application/vnd.api+json"
+      req["Authorization"] = "Bearer #{@api_key}"
+      req["User-Agent"] = "imgix #{@library}-#{@version}"
+
+      if data_fmt.is_a?(Proc)
+        req.body = data_fmt.call(resource)
+      elsif data_fmt.is_a?(Symbol)
+        req.body = send(data_fmt, resource)
+      else
+        fmt_arg_error = "`fmt' is required to be of class Symbol or " \
+          "Proc but was found to be\n\s\sof class #{data_fmt.class}\n"
+        raise ArgumentError, fmt_arg_error
+      end
+
+      req
     end
 
-    private
+    def json_data_from(url)
+      {
+        data: {
+          attributes: {
+              url: url
+          },
+          type: "purges"
+        }
+      }.to_json
+    end
 
-    def validate_host!
-      host_error = 'The :host option must be specified'
-      raise ArgumentError, host_error if @host.nil?
+    def validate_domain!
+      domain_error  = "The :domain option must be specified"
+      raise ArgumentError, domain_error if @domain.nil?
 
-      domain_error = 'Domains must be passed in as fully-qualified'\
-                     'domain names and should not include a protocol'\
+      domain_error = "Domains must be passed in as fully-qualified"\
+                     "domain names and should not include a protocol"\
                      'or any path element, i.e. "example.imgix.net"'\
 
-      if @host.match(DOMAIN_REGEX).nil?
-        raise ArgumentError, domain_error
-      end
+      raise ArgumentError, domain_error if @domain.match(DOMAIN_REGEX).nil?
     end
   end
 end