imgix 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1af83e026e72b6ce6bfcfdf1169add23c12cbec68a7d7fbe03243150c832b34b
-  data.tar.gz: 3a7e0d57c3f65b75327e226918370771f7bb579284228de9e6de77d694d4fadc
+  metadata.gz: f8de76cc2340cbfa3ecd0479b9bb421fa163f78c1e8e38011dd5938849665802
+  data.tar.gz: 10cac9471323181870d48be911b225323ccb2d02583176f45639af5c19d4eddb
 SHA512:
-  metadata.gz: 0a68e202aaa183a4974d9c15a20e97f404269879da403cb7a949c04dd5ba3053e4b4802aa2a7006826f357a4268f87fd20d14971034e598d792e18a5cd2b322d
-  data.tar.gz: e1f068f01a5cd8cac1b959bd16f9e2d586a72278a6b4be844a822c74a41c7b7e110471c36a4bf156b6ec6c17cbcc5e425ebdf40373b2424ce3360bd1ada391d2
+  metadata.gz: e2233648d430a37c9ea72d89420f492c50f28f6e341c3cf7fe70eb711983b6a7b12b0cd103b118cd8783c373cb2b27e62d53a8ae6b2f8e93946d0309d7f812e2
+  data.tar.gz: 85209a1262a7d3fd7a39796c487fe87e6c0f75a5a55213676d91834a1af456d8ff01ecb9882ff38818a9dc24c638a64f5c6171bcc09b4f415f9bc38bfb0a136c

data/.github/pull_request_template.md

@@ -27,7 +27,7 @@ Please use the checklist that is most closely related to your PR, and delete the
 
 - [ ] 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.
+- [ ] If this is a big feature with breaking changes, consider [opening an issue](https://github.com/imgix/imgix-rb/issues/new?labels=&template=feature_request.md&title=) 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

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/).
 
+## [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,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in imgix.gemspec

data/README.md

@@ -230,6 +230,8 @@ 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.
 
 ```ruby

data/Rakefile

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

data/imgix.gemspec

@@ -1,7 +1,6 @@
-# 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'

data/lib/imgix/client.rb

@@ -44,8 +44,13 @@ module Imgix
     end
 
     def purge(path)
-      token_error = 'Authentication token required'
-      raise token_error if @api_key.nil?
+      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'
+      raise api_key_error if @api_key.nil?
 
       url = new_prefix + path
       uri = URI.parse('https://api.imgix.com/v2/image/purger')

data/lib/imgix/path.rb

@@ -153,7 +153,7 @@ module Imgix
         srcset_widths = @target_widths
       end
 
-      for width in srcset_widths do
+      srcset_widths.each do |width|
         params[:w] = width
         srcset += "#{to_url(params)} #{width}w,\n"
       end
@@ -170,7 +170,7 @@ module Imgix
       target_ratios = [1, 2, 3, 4, 5]
       quality = params[:q]
 
-      for ratio in target_ratios do
+      target_ratios.each do |ratio|
         params[:dpr] = ratio
 
         unless disable_variable_quality

data/lib/imgix/version.rb

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

data/test/test_helper.rb

@@ -7,7 +7,6 @@ Bundler.require :test
 require 'minitest/autorun'
 require 'imgix'
 require 'webmock/minitest'
-include WebMock::API
 
 class Imgix::Test < MiniTest::Test
 end

data/test/units/purge_test.rb

@@ -1,25 +1,70 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class PurgeTest < Imgix::Test
   def test_runtime_error_without_api_key
-    assert_raises(RuntimeError) {
-      Imgix::Client.new(host: 'demo.imgix.net', include_library_param: false)
-      .purge('https://demo.imgix.net/images/demo.png')
-    }
+    assert_raises(RuntimeError) do
+      mock_client(api_key: nil).purge(mock_image)
+    end
+  end
+
+  def test_purger_version_warns
+    stub_request(:post, endpoint).with(body: body).to_return(status: 200)
+
+    assert_output(nil, deprecation_warning) do
+      mock_client(api_key: '10adc394').purge('/images/demo.png')
+    end
   end
-  
+
   def test_successful_purge
-    stub_request(:post, "https://api.imgix.com/v2/image/purger").
-      with(
-        body: {"url"=>"https://demo.imgix.net/images/demo.png"}).
-      to_return(status: 200)
-
-    Imgix::Client.new(host: 'demo.imgix.net', api_key: '10adc394')
-    .purge('/images/demo.png')
-    
-    assert_requested :post, 'https://api.imgix.com/v2/image/purger',
-      body:  'url=https%3A%2F%2Fdemo.imgix.net%2Fimages%2Fdemo.png',
-      headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'Basic MTBhZGMzOTQ6', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>"imgix rb-#{ Imgix::VERSION}"},
+    stub_request(:post, endpoint).with(body: body).to_return(status: 200)
+
+    mock_client(api_key: '10adc394').purge('/images/demo.png')
+
+    assert_requested(
+      :post,
+      endpoint,
+      body: 'url=https%3A%2F%2Fdemo.imgix.net%2Fimages%2Fdemo.png',
+      headers: mock_headers,
       times: 1
+    )
+  end
+
+  private
+
+  def mock_client(api_key: '')
+    Imgix::Client.new(
+      domain: 'demo.imgix.net',
+      api_key: api_key,
+      include_library_param: false
+    )
+  end
+
+  def mock_headers
+    {
+      'Accept' => '*/*',
+      'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+      'Authorization' => 'Basic MTBhZGMzOTQ6',
+      'Content-Type' => 'application/x-www-form-urlencoded',
+      'User-Agent' => "imgix rb-#{Imgix::VERSION}"
+    }
+  end
+
+  def mock_image
+    'https://demo.imgix.net/images/demo.png'
+  end
+
+  def endpoint
+    'https://api.imgix.com/v2/image/purger'
+  end
+
+  def body
+    { 'url' => mock_image }
+  end
+
+  def deprecation_warning
+    "Warning: Your `api_key` will no longer work after upgrading to\n" \
+    "imgix-rb version >= 4.0.0.\n"
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Kelly Sutton
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -87,8 +87,8 @@ licenses:
 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/3.3.1
-  source_code_uri: https://github.com/imgix/imgix-rb/tree/3.3.1
+  documentation_uri: https://www.rubydoc.info/gems/imgix/3.4.0
+  source_code_uri: https://github.com/imgix/imgix-rb/tree/3.4.0
 post_install_message: 
 rdoc_options: []
 require_paths: