imgix 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69d79131db36ca98aed6917e44b11898b6004b73
-  data.tar.gz: dec4591b291abcd3d51fef005a14838e278580b7
+  metadata.gz: 57ebb7ae8df29e8673a3c0988392313412408f0e
+  data.tar.gz: 1e465ab4bc2c1e11896bf734c7ab33b9f4bbadf2
 SHA512:
-  metadata.gz: eddc85063053ebddcd2be6f76fec68cbe27d9290fed7d8d276563ebe798183191a55353fb3a313bafa44d45f51d18cd550953ebb70bc57f9e3d925dd9a2284f1
-  data.tar.gz: 4d1f7b5365986bf462024cacadb0caa5bcb2e01059aecab04ee0a2f947b8aebd383e416b7060067211f43ae2acef621dd90c90da5fb475691265885d4ed4cae7
+  metadata.gz: d6755c1578a6677abb8bcc48c06c8886dec7202a54997a2618052bdddc96f7141a3d90b5c0707415c12df022cd7e7f65704c921db9e20ddd3cd90e0c23236b04
+  data.tar.gz: d131017e65866fb3cee2cf1adf012be943902b779eeffb147bacc46f26ffa0ced93c0e6c7928ada2a34c2281900a1e3a929b8fb299063e5adc01ab81062bd168

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 bundler_args: --without development
+before_install: gem install bundler
 rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
   - jruby-19mode
-  - rbx-19mode
+  - rbx-2

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem 'rake'
 gem 'minitest'
+gem 'addressable'

data/Readme.markdown

@@ -46,6 +46,30 @@ path.defaults.width(300).to_url # Resets parameters
 path.rect(x: 0, y: 50, width: 200, height: 300).to_url # Rect helper
 ```
 
+# Domain Sharded URLs
+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.
+For example to use the [noise reduction](http://www.imgix.com/docs/urlapi/enhance#nr-nrs) options
+
+``` ruby
+path.noise_reduction(50,50)
+```
+
+
 ## Supported Ruby Versions
 
 Imgix is tested under 1.9.2, 1.9.3, 2.0.0, JRuby 1.7.2 (1.9 mode), and Rubinius 2.0.0 (1.9 mode).

data/imgix.gemspec

@@ -6,8 +6,8 @@ require 'imgix/version'
 Gem::Specification.new do |spec|
   spec.name          = 'imgix'
   spec.version       = Imgix::VERSION
-  spec.authors       = ['Sam Soffes', 'Ryan LeFevre']
-  spec.email         = ['sam@soff.es', 'ryan@layervault.com']
+  spec.authors       = ['Sam Soffes', 'Ryan LeFevre', 'Antony Denyer']
+  spec.email         = ['sam@soff.es', 'ryan@layervault.com', 'email@antonydenyer.co.uk']
   spec.description   = 'Easily sign imgix URLs.'
   spec.summary       = 'Unofficial Ruby Gem for easily signing imgix URLs.'
   spec.homepage      = 'https://github.com/soffes/imgix-rb'

data/lib/imgix.rb

@@ -3,4 +3,5 @@ require 'imgix/client'
 require 'imgix/path'
 
 module Imgix
+  STRATEGIES = [:crc, :cycle]
 end

data/lib/imgix/client.rb

@@ -1,27 +1,65 @@
 require 'digest'
 require 'addressable/uri'
+require 'zlib'
 
 module Imgix
   class Client
+    DEFAULTS = { secure: false, shard_strategy: :crc }
+
     def initialize(options = {})
-      @host = options[:host]
+      options = DEFAULTS.merge(options)
+
+      @hosts = Array(options[:host]) + Array(options[:hosts]) and validate_hosts!
       @token = options[:token]
-      @secure = options[:secure] || false
+      @secure = options[:secure]
+      @shard_strategy = options[:shard_strategy] and validate_strategy!
     end
 
     def path(path)
-      Path.new(prefix, @token, path)
+      Path.new(prefix(path), @token, path)
     end
 
-    def prefix
-      "#{@secure ? 'https' : 'http'}://#{@host}"
+    def prefix(path)
+      "#{@secure ? 'https' : 'http'}://#{get_host(path)}"
     end
 
     def sign_path(path)
       uri = Addressable::URI.parse(path)
       query = (uri.query || '')
       signature = Digest::MD5.hexdigest(@token + uri.path + '?' + query)
-      "#{@secure ? 'https' : 'http'}://#{@host}#{uri.path}?#{query}&s=#{signature}"
+      "#{@secure ? 'https' : 'http'}://#{get_host(path)}#{uri.path}?#{query}&s=#{signature}"
+    end
+
+    def get_host(path)
+      host = host_for_crc(path) if @shard_strategy == :crc
+      host = host_for_cycle if @shard_strategy == :cycle
+      host.gsub("http://","").gsub("https://","")
+    end
+
+    def host_for_crc(path)
+      crc = Zlib.crc32(path)
+      index = crc % @hosts.length - 1
+      @hosts[index]
+    end
+
+    def host_for_cycle
+      @hosts_cycle = @hosts.cycle unless @hosts_cycle
+      @hosts_cycle.next
+    end
+
+    private
+
+    def validate_strategy!
+      unless STRATEGIES.include?(@shard_strategy)
+        raise ArgumentError.new("#{@shard_strategy} is not supported")
+      end
     end
+
+    def validate_hosts!
+      unless @hosts.length > 0
+        raise ArgumentError, "The :host or :hosts option must be specified"
+      end
+    end
+
   end
 end

data/lib/imgix/version.rb

@@ -1,3 +1,3 @@
 module Imgix
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/test/units/domains_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class DomainsTest < Imgix::Test
+
+  def test_deterministically_choosing_a_path
+    client = Imgix::Client.new(:hosts => [
+        "demos-1.imgix.net",
+        "demos-2.imgix.net",
+        "demos-3.imgix.net",
+      ],
+      :token => '10adc394')
+
+    path = client.path('/bridge.png')
+    assert_equal 'http://demos-1.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+
+    path = client.path('/flower.png')
+    assert_equal 'http://demos-2.imgix.net/flower.png?&s=7793669cc41d31fd21c26ede9709ef03', path.to_url
+  end
+
+  def test_cycling_choosing_domain_in_order
+    client = Imgix::Client.new(:hosts => [
+        "demos-1.imgix.net",
+        "demos-2.imgix.net",
+        "demos-3.imgix.net",
+      ],
+      :token => '10adc394',
+      :shard_strategy => :cycle)
+
+    path = client.path('/bridge.png')
+    assert_equal 'http://demos-1.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+
+    path = client.path('/bridge.png')
+    assert_equal 'http://demos-2.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+
+    path = client.path('/bridge.png')
+    assert_equal 'http://demos-3.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+
+    path = client.path('/bridge.png')
+    assert_equal 'http://demos-1.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+
+  end
+
+  def test_strips_out_protocol
+    client = Imgix::Client.new(:host =>
+        "http://demos-1.imgix.net",
+        :token => '10adc394')
+
+    path = client.path('/bridge.png')
+    assert_equal 'http://demos-1.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+
+  end
+
+end

data/test/units/path_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class UrlTest < Imgix::Test
+class PathTest < Imgix::Test
   def test_creating_a_path
     path = client.path('/images/demo.png')
     assert_equal 'http://demo.imgix.net/images/demo.png?&s=3c1d676d4daf28c044dd83e8548f834a', path.to_url
@@ -41,7 +41,11 @@ class UrlTest < Imgix::Test
     assert_equal url, path.height(200).width(200).to_url
   end
 
-private
+  def test_host_is_required
+    assert_raises(ArgumentError) {Imgix::Client.new}
+  end
+
+  private
 
   def client
     @client ||= Imgix::Client.new(:host => 'demo.imgix.net', :token => '10adc394')

metadata

@@ -1,40 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Soffes
 - Ryan LeFevre
+- Antony Denyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2014-06-16 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'
 description: Easily sign imgix URLs.
 email:
 - sam@soff.es
 - ryan@layervault.com
+- email@antonydenyer.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Contributing.markdown
 - Gemfile
 - LICENSE
@@ -47,6 +49,7 @@ files:
 - lib/imgix/path.rb
 - lib/imgix/version.rb
 - test/test_helper.rb
+- test/units/domains_test.rb
 - test/units/path_test.rb
 - test/units/url_test.rb
 homepage: https://github.com/soffes/imgix-rb
@@ -59,21 +62,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Unofficial Ruby Gem for easily signing imgix URLs.
 test_files:
 - test/test_helper.rb
+- test/units/domains_test.rb
 - test/units/path_test.rb
 - test/units/url_test.rb