imgix 3.4.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8de76cc2340cbfa3ecd0479b9bb421fa163f78c1e8e38011dd5938849665802
-  data.tar.gz: 10cac9471323181870d48be911b225323ccb2d02583176f45639af5c19d4eddb
+  metadata.gz: a91b4da0e3b9063761f986110ff0ab379938986186642e08ec59be0ae5601cad
+  data.tar.gz: 61a69f51d3d453480fa9f5acc496b245f65f94d7088a704fe0ee31fc4f4146dc
 SHA512:
-  metadata.gz: e2233648d430a37c9ea72d89420f492c50f28f6e341c3cf7fe70eb711983b6a7b12b0cd103b118cd8783c373cb2b27e62d53a8ae6b2f8e93946d0309d7f812e2
-  data.tar.gz: 85209a1262a7d3fd7a39796c487fe87e6c0f75a5a55213676d91834a1af456d8ff01ecb9882ff38818a9dc24c638a64f5c6171bcc09b4f415f9bc38bfb0a136c
+  metadata.gz: ae1e01d77d40bdccf28cadebb0d4a75704f1da9d0d6619c102b0e05bae680f3801675d1674b67b0fb94fb3ed5e1576e386d8c31cda5bcab252a0e997099245ff
+  data.tar.gz: b715696707c314d2a9bf047ff32ba579cf12fca5115601cc59d5db88e8407a09012a1783bb194c10a5bcc910726b8c4ca0d81f44c52e4ce109c17563baa7f4bb

data/.rubocop.yml

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

data/.travis.yml

@@ -2,6 +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

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [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))

data/Gemfile

@@ -6,6 +6,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
+gem 'json'
 gem 'minitest'
 gem 'webmock'
-gem 'addressable'

data/README.md

@@ -48,36 +48,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.
@@ -218,21 +195,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
 
-**Deprecation Notice:** The API keys used in `Imgix::Client#purge` version `3.3.X` have been deprecated. To utilize the updated `Imgix::Client#purge` method in version `4.0.0`, please regenerate your API key at `http://dashboard.imgix.com/api-keys`. Feel free to reach out to our [support line](support@imgix.com) if you have any questions or concerns.
-
-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')

data/imgix.gemspec

@@ -1,30 +1,28 @@
 # frozen_string_literal: true
 
-require_relative 'lib/imgix/version'
+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
 

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,87 +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)
-      api_key_deprecated = \
-        "Warning: Your `api_key` will no longer work after upgrading to\n" \
-        "imgix-rb version >= 4.0.0.\n"
-      warn api_key_deprecated
-
-      api_key_error = 'A valid api key is required to send purge requests'
+      api_key_error = "A valid API key is required to send purge requests"
       raise api_key_error if @api_key.nil?
 
-      url = new_prefix + path
-      uri = URI.parse('https://api.imgix.com/v2/image/purger')
-
-      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

data/lib/imgix/path.rb

@@ -1,44 +1,20 @@
 # 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] != '/'
+      @path = "/#{@path}" if @path[0] != "/"
       @target_widths = TARGET_WIDTHS.call(DEFAULT_WIDTH_TOLERANCE, MIN_WIDTH, MAX_WIDTH)
     end
 
@@ -49,7 +25,7 @@ module Imgix
       url = @prefix + path_and_params
 
       if @secure_url_token
-        url += (has_query? ? '&' : '?') + "s=#{signature}"
+        url += (has_query? ? "&" : "?") + "s=#{signature}"
       end
 
       @options = prev_options
@@ -61,53 +37,97 @@ 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 && aspect_ratio)
+          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]
-
-      srcset = if width || (height && aspect_ratio)
-                 build_dpr_srcset(options: options, params: @options)
-               else
-                 build_srcset_pairs(options: options, params: @options)
-               end
-
-      @options = prev_options
-      srcset
-    end
-
     private
 
     def signature
@@ -127,15 +147,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
@@ -162,7 +182,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)
@@ -173,9 +193,7 @@ module Imgix
       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,15 +202,13 @@ 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 }
@@ -200,18 +216,14 @@ module Imgix
     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
+      range_numeric_error = "error: `min_width` and `max_width` must be positive `Numeric` values"
+      raise ArgumentError, range_numeric_error unless min_srcset.is_a?(Numeric) && max_srcset.is_a?(Numeric)
 
-      unless min_srcset > 0 && max_srcset > 0
-        raise ArgumentError, range_numeric_error
-      end
+      raise ArgumentError, range_numeric_error unless min_srcset > 0 && max_srcset > 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