imgix 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2aca4978f5332c3f2df154b78d11ce06a9a0936a
-  data.tar.gz: adfa18dbcd36b7604c145774b3303c4da1757f76
+  metadata.gz: a7ecfad08f5fb987982e65a9e4c22a7427f08be4
+  data.tar.gz: 23579307f97e575b2f30c065360b1244795e1081
 SHA512:
-  metadata.gz: 138320aa8a36f436a552cb9fbebd4cd85381ad319a260fc3994e6769c926d871303946bc86a9df2a23f1cd7c9c61d2504ce7a414067a57da29ef061c1f563257
-  data.tar.gz: 79d3e0c87dede9a851dcaed577d1069b75855be885fe72bbac210e94001a8ef7962c8c6cb88c1f6991cd3400023355a5b626a9eb18faf0a3f4066c884abe506d
+  metadata.gz: '098a9a3ace9b4c06d8466ceb3ec4a3dc73ef64ee004d6d9d62082d200a0c19e34ad4b066eb418b36f7731213c30f1b172834e4b7a4deddc3326839ab1f12e1ae'
+  data.tar.gz: e1cd1ae2bb0eaeb1a6ddf330e53fe844d60cbc84133c102ba8f57774e3d6fe823f0eb820426af8adabacaa20b1cb9e1a77fb64cefdeb07c01e35ad649110b088

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.0.0](https://github.com/imgix/imgix-rb/compare/2.1.0...3.0.0) - June 7, 2019
+
+*  fix: remove deprecated domain sharding functionality ([#46](https://github.com/imgix/imgix-rb/pull/46))
+
 ## [2.1.0](https://github.com/imgix/imgix-rb/compare/2.0.0...2.1.0) - May 7, 2019
 
 * Deprecate domain sharding ([#43](https://github.com/imgix/imgix-rb/pull/43)) ([#45](https://github.com/imgix/imgix-rb/pull/45))

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-Simply initialize a client with a `:host` or `:hosts` and your `:secure_url_token`. By default, HTTPS URLs are generated, but you can toggle that by passing `use_https: false`.
+Simply 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`.
 
 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.
 
@@ -47,29 +47,6 @@ path.rect(x: 0, y: 50, width: 200, height: 300).to_url # Rect helper
 ```
 
 
-## Domain Sharded URLs
-**Warning: Domain Sharding has been deprecated and will be removed in the next major release**<br>
-To find out more, see our [blog post](https://blog.imgix.com/2019/05/03/deprecating-domain-sharding) explaining the decision to remove this feature.
-
-Domain sharding enables you to spread image requests across multiple domains. This allows you to bypass the requests-per-host limits of browsers. We recommend 2-3 domain shards maximum if you are going to use domain sharding.
-
-In order to use domain sharding, you need to add multiple domains to your source. You then provide a list of these domains to a builder.
-
-
-``` ruby
-client = Imgix::Client.new(hosts: ['your-subdomain-1.imgix.net',
-  'your-subdomain-2.imgix.net'])
-```
-
-By default, shards are calculated using a checksum so that the image path always resolves to the same domain. This improves caching in the browser. However, you can also specify cycle that simply cycles through the domains as you request them.
-
-
-``` ruby
-client = Imgix::Client.new(hosts: ['your-subdomain-1.imgix.net',
-  'your-subdomain-2.imgix.net'], shard_strategy: :cycle))
-```
-
-
 ## Multiple Parameters
 
 When the imgix api requires multiple parameters you have to use the method rather than an accessor.
@@ -103,7 +80,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({ include_library_param: false })
+client = Imgix::Client.new(host: 'your-subdomain.imgix.net', include_library_param: false )
 ```
 
 ## Contributing

data/lib/imgix.rb

@@ -5,6 +5,5 @@ require 'imgix/client'
 require 'imgix/path'
 
 module Imgix
-  STRATEGIES = [:crc, :cycle]
   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
 end

data/lib/imgix/client.rb

@@ -2,23 +2,21 @@
 
 require 'digest'
 require 'addressable/uri'
-require 'zlib'
 require 'net/http'
 require 'uri'
 
 module Imgix
   class Client
-    DEFAULTS = { use_https: true, shard_strategy: :crc }
+    DEFAULTS = { use_https: true }
 
     def initialize(options = {})
       options = DEFAULTS.merge(options)
 
-      deprecate_warning!(options[:host],options[:hosts])
-      @hosts = Array(options[:host]) + Array(options[:hosts]) and validate_hosts!
+      @host = options[:host]
+      validate_host!
       @secure_url_token = options[:secure_url_token]
       @api_key = options[:api_key]
       @use_https = options[:use_https]
-      @shard_strategy = options[:shard_strategy] and validate_strategy!
       @include_library_param = options.fetch(:include_library_param, true)
       @library = options.fetch(:library_param, "rb")
       @version = options.fetch(:library_version, Imgix::VERSION)
@@ -44,52 +42,19 @@ module Imgix
     end
 
     def prefix(path)
-      "#{@use_https ? 'https' : 'http'}://#{get_host(path)}"
-    end
-
-    def get_host(path)
-      host = host_for_crc(path) if @shard_strategy == :crc
-      host = host_for_cycle if @shard_strategy == :cycle
-      host
-    end
-
-    def host_for_crc(path)
-      crc = Zlib.crc32(path)
-      index = crc % @hosts.length - 1
-      @hosts[index]
-    end
-
-    def host_for_cycle
-      if not defined? @hosts_cycle
-        @hosts_cycle = @hosts.cycle
-      end
-      @hosts_cycle.next
+      "#{@use_https ? 'https' : 'http'}://#{@host}"
     end
 
     private
 
-    def validate_strategy!
-      unless STRATEGIES.include?(@shard_strategy)
-        raise ArgumentError.new("#{@shard_strategy} is not supported")
+    def validate_host!
+      unless @host != nil
+        raise ArgumentError, "The :host option must be specified"
       end
-    end
-
-    def validate_hosts!
-      unless @hosts.length > 0
-        raise ArgumentError, "The :host or :hosts option must be specified"
-      end
-      @hosts.each do |host|
-        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\"."
-        end
-      end
-    end
-
-    def deprecate_warning!(host, hosts)
-      has_many_domains = (host.kind_of?(Array) && host.length > 1 ) || (hosts.kind_of?(Array) && hosts.length > 1)
-      if has_many_domains
-        warn "Warning: Domain sharding has been deprecated and will be removed in the next major version."
+      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\"."
       end
     end
+    
   end
 end

data/lib/imgix/version.rb

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

data/test/units/domains_test.rb

@@ -3,87 +3,15 @@
 require 'test_helper'
 
 class DomainsTest < Imgix::Test
-  def test_deterministically_choosing_a_path
-    assert_output(nil, "Warning: Domain sharding has been deprecated and will be removed in the next major version.\n"){
-      client = Imgix::Client.new(hosts: [
-          "demos-1.imgix.net",
-          "demos-2.imgix.net",
-          "demos-3.imgix.net",
-        ],
-        secure_url_token: '10adc394',
-        include_library_param: false)
-
-      path = client.path('/bridge.png')
-      assert_equal 'https://demos-1.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
-
-      path = client.path('/flower.png')
-      assert_equal 'https://demos-2.imgix.net/flower.png?s=02105961388864f85c04121ea7b50e08', path.to_url
-    }
-  end
-
-  def test_cycling_choosing_domain_in_order
-    assert_output(nil, "Warning: Domain sharding has been deprecated and will be removed in the next major version.\n"){
-      client = Imgix::Client.new(hosts: [
-          "demos-1.imgix.net",
-          "demos-2.imgix.net",
-          "demos-3.imgix.net",
-        ],
-        secure_url_token: '10adc394',
-        shard_strategy: :cycle,
-        include_library_param: false)
-
-      path = client.path('/bridge.png')
-      assert_equal 'https://demos-1.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
-
-      path = client.path('/bridge.png')
-      assert_equal 'https://demos-2.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
-
-      path = client.path('/bridge.png')
-      assert_equal 'https://demos-3.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
-
-      path = client.path('/bridge.png')
-      assert_equal 'https://demos-1.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
-    }
-  end
-
-  def test_with_full_paths
-    assert_output(nil, "Warning: Domain sharding has been deprecated and will be removed in the next major version.\n"){
-      client = Imgix::Client.new(hosts: [
-          "demos-1.imgix.net",
-          "demos-2.imgix.net",
-          "demos-3.imgix.net",
-        ],
-        secure_url_token: '10adc394',
-        shard_strategy: :cycle,
-        include_library_param: false)
-
-      path = 'https://google.com/cats.gif'
-      assert_equal "https://demos-1.imgix.net/#{CGI.escape(path)}?s=e686099fbba86fc2b8141d3c1ff60605", client.path(path).to_url
-    }
-  end
-
   def test_invalid_domain_append_slash
-    assert_raises(ArgumentError) {Imgix::Client.new(hosts: "assets.imgix.net/")}
+    assert_raises(ArgumentError) {Imgix::Client.new(host: "assets.imgix.net/")}
   end
 
   def test_invalid_domain_prepend_scheme
-    assert_raises(ArgumentError) {Imgix::Client.new(hosts: "https://assets.imgix.net")}
+    assert_raises(ArgumentError) {Imgix::Client.new(host: "https://assets.imgix.net")}
   end
 
   def test_invalid_domain_append_dash
-    assert_raises(ArgumentError) {Imgix::Client.new(hosts: "assets.imgix.net-")}
-  end
-
-  def test_domain_sharding_deprecation_host
-
-    assert_output(nil, "Warning: Domain sharding has been deprecated and will be removed in the next major version.\n"){
-      Imgix::Client.new(host: ["assets1.imgix.net", "assets2.imgix.net"])
-    }
-  end
-
-  def test_domain_sharding_deprecation_hosts
-    assert_output(nil, "Warning: Domain sharding has been deprecated and will be removed in the next major version.\n"){
-      Imgix::Client.new(hosts: ["assets1.imgix.net", "assets2.imgix.net"])
-    }
+    assert_raises(ArgumentError) {Imgix::Client.new(host: "assets.imgix.net-")}
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Kelly Sutton
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2019-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable