imgix 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6bdd9b0132a6ca25ef31c4329cb9208b4797509e
-  data.tar.gz: 33b0aa5a0b0db17caba521df0c0795b018f7042e
+SHA256:
+  metadata.gz: aacdd5bdf7d625eec3ee921e77ae5abc4ce477d3acb3fe157cd8dfbba17c290b
+  data.tar.gz: fe73df2f92e6fdbba85ea88bf5354e0a3ae312f2d5d7807cf2d1e7d2085571d5
 SHA512:
-  metadata.gz: 0cb3543b4cf85f1d8226f1d9b994265936c9ff08c8db12f9d0f72f75eaa6852c26ca20fefc095935c2b3162e4c81402510df1f554507341a83ffda4f6945ee8d
-  data.tar.gz: 4089e89e2b128bf031e300f38e8686a77606f0ee8a60233d83ee89827efebf728ae86be88053ecaadb044c1f44ae9eb4c6dc1377b1f98b7587b1b680478f881f
+  metadata.gz: c61d6b8c35bc9ad6133eb72829be8afccb9aec4822775a2df0649b5c2536ba97a8b28884cc2559d3764b9cd66dd1dcd38dca8356be43f66dd8a3157e0c66db49
+  data.tar.gz: f08aab23f7211ee429f017a9ac38f9bcf6c67fd2290814b1c7503f02d3e29a6265b7f171afbe23ccd09be37fd2083104d35ea8de59c17eaf1bc764ab24468db9

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees:
+
+---
+
+Please provide the following information and someone from @imgix/imgix-sdk-team will respond to your issue shortly.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Information:**
+ - imgix-rb version: [e.g. 2.0.0]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees:
+
+---
+
+Please provide the following information and someone from @imgix/imgix-sdk-team will respond to your issue shortly.
+
+**Before you submit:**
+
+- [ ] Please search through the [existing issues](https://github.com/imgix/imgix-rb/issues?utf8=%E2%9C%93&q=is%3Aissue) to see if your feature has already been discussed.
+- [ ] Please take a moment to find out whether your idea fits with the scope and aims of this project.
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,17 @@
+---
+name: Question
+about: Ask a question about the project
+title: ''
+labels: ''
+assignees:
+
+---
+
+Please provide the following information and someone from @imgix/imgix-sdk-team will respond to your issue shortly.
+
+**Before you submit:**
+
+- [ ] Please search through the [existing issues]([existing issues](https://github.com/imgix/imgix-rb/issues?utf8=%E2%9C%93&q=is%3Aissue)) to see if your question has already been discussed.
+
+**Question**
+A clear and concise description of your question.

data/.github/pull_request_template.md

@@ -0,0 +1,73 @@
+<!--
+Hello, and thanks for contributing to imgix-rb! 🎉🙌
+Please take a second to fill out PRs with the following template!
+-->
+
+# Description
+
+<!-- What is accomplished by this PR? If there is something potentially controversial in your PR, please take a moment to tell us about your choices. -->
+
+<!-- 
+Please use the checklist that is most closely related to your PR, and delete the other checklists. -->
+
+## Checklist: Fixing typos/Doc change
+
+- [ ] Each commit follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) format: e.g. `chore(readme): fixed typo`. See the end of this file for more information.
+
+## Checklist: Bug Fix
+
+- [ ] Each commit follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) format: e.g. `chore(readme): fixed typo`. See the end of this file for more information.
+- [ ] All existing unit tests are still passing (if applicable)
+- [ ] Add new passing unit tests to cover the code introduced by your PR
+- [ ] Update the readme
+- [ ] Update or add any necessary API documentation
+- [ ] Add some [steps](#steps-to-test) so we can test your bug fix
+
+## Checklist: New Feature
+
+- [ ] Each commit follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) format: e.g. `chore(readme): fixed typo`. See the end of this file for more information.
+- [ ] Any breaking changes are specified on the commit on which they are introduced with `BREAKING CHANGE` in the body of the commit.
+- [ ] If this is a big feature with breaking changes, consider [opening an issue][issues] to discuss first. This is completely up to you, but please keep in mind that your PR might not be accepted.
+- [ ] Run unit tests to ensure all existing tests are still passing
+- [ ] Add new passing unit tests to cover the code introduced by your PR
+- [ ] Update the readme
+- [ ] Add some [steps](#steps-to-test) so we can test your cool new feature!
+
+## Steps to Test
+
+<!-- Delete this selction if you are just submitting a doc change/small fix -->
+
+<!-- A code example or a set of steps is preferred -->
+
+Related issue: [e.g. #42]
+
+Code:
+
+```rb
+// A standalone Ruby example of what the PR solves
+```
+
+<!-- A link to a codepen/codesandbox is also an option. -->
+
+<!--
+
+## Conventional Commit Spec
+
+PR titles should be in the format `<type>(<scope>): <description>`. For example: `chore(readme): fix typo`
+
+`type` can be any of the follow:
+  - `feat`: a feature, or breaking change
+  - `fix`: a bug-fix
+  - `test`: Adding missing tests or correcting existing tests
+  - `docs`: documentation only changes (readme, changelog, contributing guide)
+  - `refactor`: a code change that neither fixes a bug nor adds a feature
+  - `chore`: reoccurring tasks for project maintainability (example scopes: release, deps)
+  - `config`: changes to tooling configurations used in the project
+  - `build`: changes that affect the build system or external dependencies (example scopes: npm, bundler, gradle)
+  - `ci`: changes to CI configuration files and scripts (example scopes: travis)
+  - `perf`: a code change that improves performance
+  - `style`: changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+
+`scope` is optional, and can be anything.
+`description` should be a short description of the change, written in the imperative-mood.
+-->

data/.travis.yml

@@ -5,5 +5,17 @@ rvm:
   - 2.3.0
   - 2.2.4
   - 2.1.8
-  - jruby-9.0.5.0
-  - rbx-3.107
+  - jruby-9.2.11.0
+
+jobs:
+  # Use `fast_finish`, don't wait for any allowed failures.
+  fast_finish: true
+
+  include:
+    - name: Rubinius
+      rvm: rbx-3.107
+      dist: trusty
+  
+  allow_failures:
+    - name: Rubinius
+ 

data/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.3.0](https://github.com/imgix/imgix-rb/compare/3.2.1...3.3.0) - July 21, 2020
+
+* fix: warn prefix-with-args is deprecated ([#78](https://github.com/imgix/imgix-rb/pull/78))
+* fix: warn host has been deprecated in favor of domain ([#76](https://github.com/imgix/imgix-rb/pull/76))
+* fix: deprecate ALIASES and corresponding define_method(s) ([#75](https://github.com/imgix/imgix-rb/pull/75))
+* fix: deprecate ParamHelpers.rect ([#74](https://github.com/imgix/imgix-rb/pull/74))
+* fix: allow rbx-3.107 to fail (travis-config) ([#70](https://github.com/imgix/imgix-rb/pull/70))
+* fix: remove ensure even requirement ([#69](https://github.com/imgix/imgix-rb/pull/69))
+
 ## [3.2.1](https://github.com/imgix/imgix-rb/compare/3.2.0...3.2.1) - November 15, 2019
 
 * fix: duplicate entries when using `min_width` or `max_width` ([#59](https://github.com/imgix/imgix-rb/pull/59))

data/README.md

@@ -1,8 +1,29 @@
-# Imgix
-
-Official Ruby Gem for signing [imgix](http://imgix.com) URLs. Tested under 2.3.0, 2.2.4, 2.1.8, jruby-9.0.5.0, and rbx-2.11.
-
-[![Build Status](https://travis-ci.org/imgix/imgix-rb.svg?branch=master)](https://travis-ci.org/imgix/imgix-rb)
+<!-- ix-docs-ignore -->
+![imgix logo](https://assets.imgix.net/sdk-imgix-logo.svg)
+
+`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)
+![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)
+
+---
+<!-- /ix-docs-ignore -->
+
+- [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)
+- [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)
 
 ## Installation
 
@@ -23,12 +44,12 @@ Or install it yourself as:
 
 ## Usage
 
-Initialize a client with a `:host` and your `:secure_url_token`. By default, HTTPS URLs are generated, but you can toggle that by passing `use_https: false`.
+Initialize a client with a `:domain` and your `:secure_url_token`. By default, HTTPS URLs are generated, but you can toggle that by passing `use_https: false`.
 
 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
-client = Imgix::Client.new(host: 'your-subdomain.imgix.net', secure_url_token: 'your-token')
+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
@@ -46,12 +67,23 @@ 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.
 
 ```rb
-client = Imgix::Client.new(host: 'your-subdomain.imgix.net', secure_url_token: 'your-token', include_library_param: false)
+client = Imgix::Client.new(domain: 'your-subdomain.imgix.net', secure_url_token: 'your-token', include_library_param: false)
 path = client.path('/images/demo.png')
 
 srcset = path.to_srcset
@@ -73,7 +105,7 @@ https://your-subdomain.imgix.net/images/demo.png?w=8192&s=9fbd257c53e770e345ce34
 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', include_library_param: false)
+client = Imgix::Client.new(domain: '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', fit:'crop')
@@ -96,7 +128,7 @@ For more information to better understand `srcset`, we highly recommend [Eric Po
 In situations where specific widths are desired when generating `srcset` pairs, a user can specify them by passing an array of integers via `widths` to the `options` keyword argument.
 
 ```rb
-@client ||= Imgix::Client.new(host: 'testing.imgix.net', include_library_param: false)
+@client ||= Imgix::Client.new(domain: 'testing.imgix.net', include_library_param: false)
 .path('image.jpg')
 .to_srcset(options: { widths: [100, 500, 1000, 1800] })
 ```
@@ -119,7 +151,7 @@ The `srcset` width tolerance dictates the maximum tolerated size difference betw
 By default this rate is set to 8 percent, which we consider to be the ideal rate for maximizing cache hits without sacrificing visual quality. Users can specify their own width tolerance by passing a positive numeric value to `width_tolerance` within the `options` keyword argument:
 
 ```rb
-client = Imgix::Client.new(host: 'testing.imgix.net', secure_url_token: 'MYT0KEN', include_library_param: false)
+client = Imgix::Client.new(domain: 'testing.imgix.net', secure_url_token: 'MYT0KEN', include_library_param: false)
 client.path('image.jpg').to_srcset(options: { width_tolerance: 0.20 })
 ```
 
@@ -138,7 +170,7 @@ https://testing.imgix.net/image.jpg?w=8192 8192w
 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:
 
 ```rb
-client = Imgix::Client.new(host: 'testing.imgix.net', include_library_param: false)
+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 })
 ```
 
@@ -171,7 +203,7 @@ This behavior will respect any overriding `q` value passed in as a parameter. Ad
 This behavior specifically occurs when a [fixed-size image](https://github.com/imgix/imgix-rb#fixed-image-rendering) is rendered, for example:
 
 ```rb
-srcset = Imgix::Client.new(host: 'testing.imgix.net', include_library_param: false)
+srcset = Imgix::Client.new(domain: 'testing.imgix.net', include_library_param: false)
 .path('image.jpg')
 .to_srcset(w:100)
 ```
@@ -201,15 +233,15 @@ path.noise_reduction(50,50)
 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.
 
 ```ruby
-client = Imgix::Client.new(host: 'your-subdomain.imgix.net', api_key: 'your-key')
+client = Imgix::Client.new(domain: 'your-subdomain.imgix.net', api_key: 'your-key')
 client.purge('/images/demo.png')
 ```
 
 To learn more about purging assets with imgix, [see our docs](https://docs.imgix.com/setup/purging-images).
 
-## URL encoding and signed ImgIX URLs
+## URL encoding and signed imgix URLs
 
-Some important third parties (like Facebook) apply URL escaping to query string components, which can cause correctly signed ImgIX URLs to to be transformed into incorrectly signed ones. We URL encode the query part of the URL before signing, so you don't have to worry about this.
+Some important third parties (like Facebook) apply URL escaping to query string components, which can cause correctly signed imgix URLs to to be transformed into incorrectly signed ones. We URL encode the query part of the URL before signing, so you don't have to worry about this.
 
 ## What is the `ixlib` param on every request?
 
@@ -218,7 +250,7 @@ For security and diagnostic purposes, we sign all requests with the language and
 This can be disabled by including `include_library_param: false` in the instantiation Hash parameter for `Imgix::Client`:
 
 ```ruby
-client = Imgix::Client.new(host: 'your-subdomain.imgix.net', include_library_param: false )
+client = Imgix::Client.new(domain: 'your-subdomain.imgix.net', include_library_param: false )
 ```
 
 ## Contributing

data/imgix.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata = {
     'bug_tracker_uri'   => 'https://github.com/imgix/imgix-rb/issues',
-    'changelog_uri'     => 'https://github.com/imgix/imgix-rb/blob/master/CHANGELOG.md',
+    '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}"
   }

data/lib/imgix.rb

@@ -6,7 +6,7 @@ require 'imgix/path'
 
 module Imgix
   # regex pattern used to determine if a domain is valid
-  DOMAIN_REGEX = /^(?:[a-z\d\-_]{1,62}\.){0,125}(?:[a-z\d](?:\-(?=\-*[a-z\d])|[a-z]|\d){0,62}\.)[a-z\d]{1,63}$/i
+  DOMAIN_REGEX = /^(?:[a-z\d\-_]{1,62}\.){0,125}(?:[a-z\d](?:\-(?=\-*[a-z\d])|[a-z]|\d){0,62}\.)[a-z\d]{1,63}$/i.freeze
 
   # determines the growth rate when building out srcset pair widths
   DEFAULT_WIDTH_TOLERANCE = 0.08
@@ -20,17 +20,19 @@ module Imgix
   # returns an array of width values used during scrset generation
   TARGET_WIDTHS = lambda { |tolerance, min, max|
     increment_percentage = tolerance || DEFAULT_WIDTH_TOLERANCE
-    unless increment_percentage.is_a? Numeric and increment_percentage > 0
-      raise ArgumentError, "The width_tolerance argument must be passed a positive scalar value"
+
+    unless increment_percentage.is_a?(Numeric) && increment_percentage > 0
+      width_increment_error = 'error: `width_tolerance` must be a positive `Numeric` value'
+      raise ArgumentError, width_increment_error
     end
 
     max_size = max || MAX_WIDTH
     resolutions = []
     prev = min || MIN_WIDTH
 
-    while(prev < max_size)
+    while prev < max_size
       # ensures that each width is even
-      resolutions.push((2 * (prev / 2).round))
+      resolutions.push(prev.round)
       prev *= 1 + (increment_percentage * 2)
     end
 
@@ -40,10 +42,10 @@ module Imgix
 
   # hash of default quality parameter values mapped  by each dpr srcset entry
   DPR_QUALITY = {
-    1 => 75, 
+    1 => 75,
     2 => 50,
     3 => 35,
     4 => 23,
     5 => 20
-  }
+  }.freeze
 end

data/lib/imgix/client.rb

@@ -7,54 +7,84 @@ require 'uri'
 
 module Imgix
   class Client
-    DEFAULTS = { use_https: true }
+    DEFAULTS = { use_https: true }.freeze
 
     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
+      end
 
-      @host = options[:host]
       validate_host!
+
       @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(prefix(path), @secure_url_token, path)
+      p = Path.new(new_prefix, @secure_url_token, path)
       p.ixlib("#{@library}-#{@version}") if @include_library_param
       p
     end
 
     def purge(path)
-      raise "Authentication token required" unless !!(@api_key)
-      url = prefix(path)+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')
-      req = Net::HTTP::Post.new(uri.path, {"User-Agent" => "imgix #{@library}-#{@version}"})
+
+      user_agent = { 'User-Agent' => "imgix #{@library}-#{@version}" }
+
+      req = Net::HTTP::Post.new(uri.path, user_agent)
       req.basic_auth @api_key, ''
-      req.set_form_data({'url' => url})
+      req.set_form_data({ url: url })
+
       sock = Net::HTTP.new(uri.host, uri.port)
       sock.use_ssl = true
-      res = sock.start {|http| http.request(req) }
+      res = sock.start { |http| http.request(req) }
+
       res
     end
 
     def prefix(path)
+      msg = "Warning: `Client::prefix' will take zero arguments " \
+        "in the next major version.\n"
+      warn msg
+      new_prefix
+    end
+
+    def new_prefix
       "#{@use_https ? 'https' : 'http'}://#{@host}"
     end
 
     private
 
     def validate_host!
-      unless @host != nil
-        raise ArgumentError, "The :host option must be specified"
-      end
-      if @host.match(DOMAIN_REGEX) == nil
-        raise ArgumentError, "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\"."
+      host_error = 'The :host option must be specified'
+      raise ArgumentError, host_error if @host.nil?
+
+      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
     end
-    
   end
 end