imgix 3.4.0 → 4.0.0

data/lib/imgix/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Kelly Sutton
@@ -13,36 +13,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2020-08-27 00:00:00.000000000 Z
+dependencies: []
 description: Easily create and sign imgix URLs.
 email:
 - kelly@imgix.com
@@ -55,12 +27,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/ISSUE_TEMPLATE/question.md"
-- ".github/pull_request_template.md"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Contributing.markdown
@@ -71,24 +39,16 @@ files:
 - imgix.gemspec
 - lib/imgix.rb
 - lib/imgix/client.rb
-- lib/imgix/param_helpers.rb
 - lib/imgix/path.rb
 - lib/imgix/version.rb
-- test/test_helper.rb
-- test/units/domains_test.rb
-- test/units/param_helpers_test.rb
-- test/units/path_test.rb
-- test/units/purge_test.rb
-- test/units/srcset_test.rb
-- test/units/url_test.rb
 homepage: https://github.com/imgix/imgix-rb
 licenses:
 - MIT
 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.4.0
-  source_code_uri: https://github.com/imgix/imgix-rb/tree/3.4.0
+  documentation_uri: https://www.rubydoc.info/gems/imgix/4.0.0
+  source_code_uri: https://github.com/imgix/imgix-rb/tree/4.0.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -108,11 +68,4 @@ rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Official Ruby Gem for easily creating and signing imgix URLs.
-test_files:
-- test/test_helper.rb
-- test/units/domains_test.rb
-- test/units/param_helpers_test.rb
-- test/units/path_test.rb
-- test/units/purge_test.rb
-- test/units/srcset_test.rb
-- test/units/url_test.rb
+test_files: []

data/.github/CODEOWNERS

@@ -1,2 +0,0 @@
-# Default owners for repo
-*       @imgix/imgix-sdk-team

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,28 +0,0 @@
----
-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

@@ -1,27 +0,0 @@
----
-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

@@ -1,17 +0,0 @@
----
-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](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

@@ -1,73 +0,0 @@
-<!--
-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](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
-- [ ] 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/lib/imgix/param_helpers.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Imgix
-  module ParamHelpers
-    def rect(position)
-      warn "Warning: `ParamHelpers.rect` has been deprecated and will be removed in the next major version.\n"
-      @options[:rect] = position and return self if position.is_a?(String)
-
-      @options[:rect] = [
-        position[:x] || position[:left],
-        position[:y] || position[:top],
-        position[:width] || (position[:right] - position[:left]),
-        position[:height] || (position[:bottom] - position[:top])
-      ].join(',')
-
-      return self
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubygems'
-require 'bundler'
-Bundler.require :test
-
-require 'minitest/autorun'
-require 'imgix'
-require 'webmock/minitest'
-
-class Imgix::Test < MiniTest::Test
-end

data/test/units/domains_test.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class DomainsTest < Imgix::Test
-  def test_invalid_domain_append_slash
-    assert_raises(ArgumentError) {Imgix::Client.new(host: "assets.imgix.net/")}
-  end
-
-  def test_invalid_domain_prepend_scheme
-    assert_raises(ArgumentError) {Imgix::Client.new(host: "https://assets.imgix.net")}
-  end
-
-  def test_invalid_domain_append_dash
-    assert_raises(ArgumentError) {Imgix::Client.new(host: "assets.imgix.net-")}
-  end
-end

data/test/units/param_helpers_test.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class ParamHelpers < Imgix::Test
-  def test_param_helpers_emits_dep_warning
-    host_warn = "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"
-
-    assert_output(nil, host_warn) {
-        client = Imgix::Client.new(host: 'test.imgix.net')
-
-        rect_warn = "Warning: `ParamHelpers.rect` has been deprecated and " \
-                    "will be removed in the next major version.\n"
-
-        assert_output(nil, rect_warn){
-            client.path('/images/demo.png').rect(x: 0, y: 50, width: 200, height: 300)
-        }
-    }
-  end
-end

data/test/units/path_test.rb

@@ -1,182 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class PathTest < Imgix::Test
-  def test_prefix_with_arg_warns
-    prefix_warn = "Warning: `Client::prefix' will take zero arguments " \
-      "in the next major version.\n"
-
-    assert_output(nil, prefix_warn) {
-      Imgix::Client.new(
-        domain: 'test.imgix.net',
-        include_library_param: false
-      ).prefix("")
-    }
-
-    # `new_prefix' is a placeholder until the bump, when it will become
-    # `prefix`.
-    assert_output(nil, nil) {
-      Imgix::Client.new(
-        domain: 'test.imgix.net',
-        include_library_param: false
-      ).new_prefix
-    }
-  end
-
-  def test_creating_a_path
-    path = client.path('/images/demo.png')
-    assert_equal 'https://demo.imgix.net/images/demo.png?s=2c7c157eaf23b06a0deb2f60b81938c4', path.to_url
-
-    path = client.path('images/demo.png')
-    assert_equal 'https://demo.imgix.net/images/demo.png?s=2c7c157eaf23b06a0deb2f60b81938c4', path.to_url
-  end
-
-  def test_signing_path_with_param
-    url = 'https://demo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e'
-    path = client.path('/images/demo.png')
-
-    assert_output(nil, "Warning: `Path.width=' has been deprecated and " \
-      "will be removed in the next major version (along " \
-      "with all parameter `ALIASES`).\n") {
-        path.width = 200
-    }
-
-    assert_equal url, path.to_url
-
-    path = client.path('/images/demo.png')
-    assert_equal url, path.to_url(w: 200)
-
-    path = client.path('/images/demo.png')
-
-    assert_output(nil, "Warning: `Path.width' has been deprecated and " \
-      "will be removed in the next major version (along " \
-      "with all parameter `ALIASES`).\n") {
-        assert_equal url, path.width(200).to_url
-    }
-  end
-
-  def test_resetting_defaults
-    url = 'https://demo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e'
-    path = client.path('/images/demo.png')
-    
-    assert_output(nil, "Warning: `Path.height=' has been deprecated and " \
-      "will be removed in the next major version (along " \
-      "with all parameter `ALIASES`).\n") {
-        path.height = 300
-    }
-
-    assert_equal url, path.defaults.to_url(w: 200)
-  end
-
-  def test_path_with_multiple_params
-    url = 'https://demo.imgix.net/images/demo.png?h=200&w=200&s=d570a1ecd765470f7b34a69b56718a7a'
-    path = client.path('/images/demo.png')
-
-    assert_equal url, path.to_url(h: 200, w: 200)
-
-    path = client.path('/images/demo.png')
-
-    assert_output(nil, "Warning: `Path.height' has been deprecated and " \
-      "will be removed in the next major version (along " \
-      "with all parameter `ALIASES`).\n") {
-        path.height(200)
-    }
-
-
-    assert_output(nil, "Warning: `Path.width' has been deprecated and " \
-      "will be removed in the next major version (along " \
-      "with all parameter `ALIASES`).\n") {
-        path.width(200)
-    }
-
-    assert_equal url, path.to_url
-  end
-
-  def test_path_with_multi_value_param_safely_encoded
-    url = 'https://demo.imgix.net/images/demo.png?markalign=middle%2Ccenter&s=f0d0e28a739f022638f4ba6dddf9b694'
-    path = client.path('/images/demo.png')
-
-    assert_equal url, path.markalign('middle', 'center').to_url
-  end
-
-  def test_param_keys_are_escaped
-    ix_url = unsigned_client.path('demo.png').to_url({
-      :'hello world' => 'interesting'
-    })
-
-    assert_equal "https://demo.imgix.net/demo.png?hello%20world=interesting", ix_url
-  end
-
-  def test_param_values_are_escaped
-    ix_url = unsigned_client.path('demo.png').to_url({
-      hello_world: '/foo"> <script>alert("hacked")</script><'
-    })
-
-    assert_equal "https://demo.imgix.net/demo.png?hello_world=%2Ffoo%22%3E%20%3Cscript%3Ealert%28%22hacked%22%29%3C%2Fscript%3E%3C", ix_url
-  end
-
-  def test_base64_param_variants_are_base64_encoded
-    ix_url = unsigned_client.path('~text').to_url({
-      txt64: 'I cannøt belîév∑ it wors! 😱'
-    })
-
-    assert_equal "https://demo.imgix.net/~text?txt64=SSBjYW5uw7h0IGJlbMOuw6l24oiRIGl0IHdvcu-jv3MhIPCfmLE", ix_url
-  end
-
-  def test_host_is_required
-    assert_raises(ArgumentError) {Imgix::Client.new}
-  end
-
-  def test_token_is_optional
-    client = Imgix::Client.new(host: 'demo.imgix.net', include_library_param: false)
-    url = 'https://demo.imgix.net/images/demo.png'
-    path = client.path('/images/demo.png')
-
-    assert_equal url, path.to_url
-  end
-
-  def test_https_is_optional
-    client = Imgix::Client.new(host: 'demo.imgix.net', include_library_param: false, use_https: false)
-    url = 'http://demo.imgix.net/images/demo.png'
-    path = client.path('/images/demo.png')
-
-    assert_equal url, path.to_url
-  end
-
-  def test_full_url
-    path = 'https://google.com/cats.gif'
-
-    assert_equal "https://demo.imgix.net/#{CGI.escape(path)}?s=e686099fbba86fc2b8141d3c1ff60605", client.path(path).to_url
-  end
-
-  def test_full_url_with_a_space
-    path = 'https://my-demo-site.com/files/133467012/avatar icon.png'
-    assert_equal "https://demo.imgix.net/#{CGI.escape(path)}?s=35ca40e2e7b6bd208be2c4f7073f658e", client.path(path).to_url
-  end
-
-  def test_include_library_param
-    client = Imgix::Client.new(host: 'demo.imgix.net') # enabled by default
-    url = client.path('/images/demo.png').to_url
-
-    assert_equal "ixlib=rb-#{Imgix::VERSION}", URI(url).query
-  end
-
-  def test_configure_library_param
-    library = "sinatra"
-    version = Imgix::VERSION
-    client = Imgix::Client.new(host: 'demo.imgix.net', library_param: library, library_version: version) # enabled by default
-    url = client.path('/images/demo.png').to_url
-
-    assert_equal "ixlib=#{library}-#{version}", URI(url).query
-  end
-
-private
-  def client
-    @client ||= Imgix::Client.new(host: 'demo.imgix.net', secure_url_token: '10adc394', include_library_param: false)
-  end
-
-  def unsigned_client
-    @unsigned_client ||= Imgix::Client.new(host: 'demo.imgix.net', include_library_param: false)
-  end
-end