imgix 0.3.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79cf096d23e38b34516352b6d161e9f3991b3c44
-  data.tar.gz: 30ad381cd316adb07a58bda15228b4e89ce9221e
+  metadata.gz: 027c32d72ff3ee11467364ed4771838dc324f134
+  data.tar.gz: 6df850a7689330e587aa81f536f4308d7c0cb50f
 SHA512:
-  metadata.gz: 9ef40e955e3a043eeafdfacab5ae11a12bff09135caf24aa402925d69e3260f6743f9d26369c9bbbe667e81ab12efdc76adb9468710d4440bf9d4472501093bd
-  data.tar.gz: 018c2e788a1fc6d3f88c7b84d2231a630d193de2ee3f85a0f0f3e96169f4f3262273864243579fe39e24e3a2692e055eb8d0d6f39387727646c26f73c37c1126
+  metadata.gz: 8bc8ca0fafa2733e9c4d2716793c07e3221add977a5870f462410fe414d350b73ac907353a00188fe5457966cec9b624628752f07c663941f9ea0cd46f6b1811
+  data.tar.gz: d17301a5b9a127d8cac312eeaca33c01aa2ec9af693f8003acb20334b5425b3667bb815b5e3bdf06a32da2972c047372c5f700191d021345d4d737ac7703ad47

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/).
 
+## [1.0.0] - December 9, 2015
+### Changed
+- Removed `Client#sign_path` to provide a consistent method and code path for generating URLs. [#16](https://github.com/imgix/imgix-rb/issues/16)
+- Changed `:secure` option to the more clear `:use_https` [#11](https://github.com/imgix/imgix-rb/issues/11)
+- Changed `:token` option to the more clear `:secure_url_token` [#11](https://github.com/imgix/imgix-rb/issues/11)
+
+### Fixed
+- Fixed URL query strings beginning with `?&s=` instead of `?s=` when no other params are present. [#15](https://github.com/imgix/imgix-rb/issues/15)
+
 ## [0.3.3] - May 14, 2015
 ### Fixed
 - Fixed a bug where URLs as the path component for Web Proxy sources would not be encoded would generate URLs that would result in a 400 Bad Request. [#8](https://github.com/imgix/imgix-rb/pull/8)

data/README.md

@@ -23,18 +23,15 @@ Or install it yourself as:
 
 ## Usage
 
-Simply initialize a client with a host and your token. You can optionally generate secure URLs.
+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`.
 
-Now, if you have the URL ready to go, you can call `sign_path` to get the Imgix URL back. If you would like to manipulate the path parameters you can call `path` with the resource path to get an Imgix::Path object back.
+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', token: 'your-token', secure: true)
+client = Imgix::Client.new(host: 'your-subdomain.imgix.net', secure_url_token: 'your-token')
 
-client.sign_path('/images/demo.png?w=200')
-#=> https://your-subdomain.imgix.net/images/demo.png?w=200&s=2eadddacaa9bba4b88900d245f03f51e
-
-# OR
 client.path('/images/demo.png').to_url(w: 200)
+#=> https://your-subdomain.imgix.net/images/demo.png?w=200&s=2eadddacaa9bba4b88900d245f03f51e
 
 # OR
 path = client.path('/images/demo.png')

data/imgix.gemspec

@@ -6,10 +6,10 @@ require 'imgix/version'
 Gem::Specification.new do |spec|
   spec.name          = 'imgix'
   spec.version       = Imgix::VERSION
-  spec.authors       = ['Kelly Sutton', 'Sam Soffes', 'Ryan LeFevre', 'Antony Denyer']
-  spec.email         = ['kelly@imgix.com', '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.authors       = ['Kelly Sutton', 'Sam Soffes', 'Ryan LeFevre', 'Antony Denyer', 'Paul Straw']
+  spec.email         = ['kelly@imgix.com', 'sam@soff.es', 'ryan@layervault.com', 'email@antonydenyer.co.uk', 'paul@imgix.com']
+  spec.description   = 'Easily create and sign imgix URLs.'
+  spec.summary       = 'Official Ruby Gem for easily creating and signing imgix URLs.'
   spec.homepage      = 'https://github.com/imgix/imgix-rb'
   spec.license       = 'MIT'
 

data/lib/imgix/client.rb

@@ -4,14 +4,14 @@ require 'zlib'
 
 module Imgix
   class Client
-    DEFAULTS = { secure: false, shard_strategy: :crc }
+    DEFAULTS = { use_https: true, shard_strategy: :crc }
 
     def initialize(options = {})
       options = DEFAULTS.merge(options)
 
       @hosts = Array(options[:host]) + Array(options[:hosts]) and validate_hosts!
-      @token = options[:token]
-      @secure = options[:secure]
+      @secure_url_token = options[:secure_url_token]
+      @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")
@@ -19,24 +19,13 @@ module Imgix
     end
 
     def path(path)
-      p = Path.new(prefix(path), @token, path)
+      p = Path.new(prefix(path), @secure_url_token, path)
       p.ixlib("#{@library}-#{@version}") if @include_library_param
       p
     end
 
     def prefix(path)
-      "#{@secure ? 'https' : 'http'}://#{get_host(path)}"
-    end
-
-    def sign_path(path)
-      uri = Addressable::URI.parse(path)
-      query = (uri.query || '')
-      path = "#{@secure ? 'https' : 'http'}://#{get_host(path)}#{uri.path}?#{query}"
-      if @token
-        signature = Digest::MD5.hexdigest(@token + uri.path + '?' + query)
-        path += "&s=#{signature}"
-      end
-      return path
+      "#{@use_https ? 'https' : 'http'}://#{get_host(path)}"
     end
 
     def get_host(path)

data/lib/imgix/path.rb

@@ -27,9 +27,9 @@ module Imgix
       quality:         :q
     }
 
-    def initialize(prefix, token, path = '/')
+    def initialize(prefix, secure_url_token, path = '/')
       @prefix = prefix
-      @token = token
+      @secure_url_token = secure_url_token
       @path = path
       @options = {}
 
@@ -37,17 +37,14 @@ module Imgix
       @path = "/#{@path}" if @path[0] != '/'
     end
 
-    def to_url(opts={})
+    def to_url(opts = {})
       prev_options = @options.dup
       @options.merge!(opts)
 
       url = @prefix + path_and_params
 
-      if @token
-        # Weird bug in imgix. If there are no params, you still have
-        # to put & in front of the signature or else you will get
-        # unauthorized.
-        url += "&s=#{signature}"
+      if @secure_url_token
+        url += (has_query? ? '&' : '?') + "s=#{signature}"
       end
 
       @options = prev_options
@@ -85,15 +82,19 @@ module Imgix
     private
 
     def signature
-      Digest::MD5.hexdigest(@token + @path + '?' + query)
+      Digest::MD5.hexdigest(@secure_url_token + path_and_params)
     end
 
     def path_and_params
-      "#{@path}?#{query}"
+      has_query? ? "#{@path}?#{query}" : @path
     end
 
     def query
       @options.map { |k, v| "#{k.to_s}=#{CGI.escape(v.to_s)}" }.join('&')
     end
+
+    def has_query?
+      query.length > 0
+    end
   end
 end

data/lib/imgix/version.rb

@@ -1,3 +1,3 @@
 module Imgix
-  VERSION = '0.3.5'
+  VERSION = '1.0.0'
 end

data/test/units/domains_test.rb

@@ -3,65 +3,64 @@ require 'test_helper'
 class DomainsTest < Imgix::Test
 
   def test_deterministically_choosing_a_path
-    client = Imgix::Client.new(:hosts => [
+    client = Imgix::Client.new(hosts: [
         "demos-1.imgix.net",
         "demos-2.imgix.net",
         "demos-3.imgix.net",
       ],
-      :token => '10adc394',
-      :include_library_param => false)
+      secure_url_token: '10adc394',
+      include_library_param: false)
 
     path = client.path('/bridge.png')
-    assert_equal 'http://demos-1.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+    assert_equal 'https://demos-1.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
 
     path = client.path('/flower.png')
-    assert_equal 'http://demos-2.imgix.net/flower.png?&s=7793669cc41d31fd21c26ede9709ef03', path.to_url
+    assert_equal 'https://demos-2.imgix.net/flower.png?s=02105961388864f85c04121ea7b50e08', path.to_url
   end
 
   def test_cycling_choosing_domain_in_order
-    client = Imgix::Client.new(:hosts => [
+    client = Imgix::Client.new(hosts: [
         "demos-1.imgix.net",
         "demos-2.imgix.net",
         "demos-3.imgix.net",
       ],
-      :token => '10adc394',
-      :shard_strategy => :cycle,
-      :include_library_param => false)
+      secure_url_token: '10adc394',
+      shard_strategy: :cycle,
+      include_library_param: false)
 
     path = client.path('/bridge.png')
-    assert_equal 'http://demos-1.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+    assert_equal 'https://demos-1.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
 
     path = client.path('/bridge.png')
-    assert_equal 'http://demos-2.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+    assert_equal 'https://demos-2.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
 
     path = client.path('/bridge.png')
-    assert_equal 'http://demos-3.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+    assert_equal 'https://demos-3.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
 
     path = client.path('/bridge.png')
-    assert_equal 'http://demos-1.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+    assert_equal 'https://demos-1.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
   end
 
   def test_strips_out_protocol
-    client = Imgix::Client.new(:host =>
-        "http://demos-1.imgix.net",
-        :token => '10adc394',
-      :include_library_param => false)
+    client = Imgix::Client.new(host: "http://demos-1.imgix.net",
+      secure_url_token: '10adc394',
+      include_library_param: false)
 
     path = client.path('/bridge.png')
-    assert_equal 'http://demos-1.imgix.net/bridge.png?&s=13e68f249172e5f790344e85e7cdb14b', path.to_url
+    assert_equal 'https://demos-1.imgix.net/bridge.png?s=0233fd6de51f20f11cff6b452b7a9a05', path.to_url
   end
 
   def test_with_full_paths
-    client = Imgix::Client.new(:hosts => [
+    client = Imgix::Client.new(hosts: [
         "demos-1.imgix.net",
         "demos-2.imgix.net",
         "demos-3.imgix.net",
       ],
-      :token => '10adc394',
-      :shard_strategy => :cycle,
-      :include_library_param => false)
+      secure_url_token: '10adc394',
+      shard_strategy: :cycle,
+      include_library_param: false)
 
     path = 'https://google.com/cats.gif'
-    assert_equal "http://demos-1.imgix.net/#{CGI.escape(path)}?&s=4c3ff935011f0d2251800e6a2bb68ee5", client.path(path).to_url
+    assert_equal "https://demos-1.imgix.net/#{CGI.escape(path)}?s=e686099fbba86fc2b8141d3c1ff60605", client.path(path).to_url
   end
 end

data/test/units/path_test.rb

@@ -3,14 +3,14 @@ require 'test_helper'
 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
+    assert_equal 'https://demo.imgix.net/images/demo.png?s=2c7c157eaf23b06a0deb2f60b81938c4', path.to_url
 
     path = client.path('images/demo.png')
-    assert_equal 'http://demo.imgix.net/images/demo.png?&s=3c1d676d4daf28c044dd83e8548f834a', path.to_url
+    assert_equal 'https://demo.imgix.net/images/demo.png?s=2c7c157eaf23b06a0deb2f60b81938c4', path.to_url
   end
 
   def test_signing_path_with_param
-    url = 'http://demo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e'
+    url = 'https://demo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e'
     path = client.path('/images/demo.png')
     path.width = 200
 
@@ -24,7 +24,7 @@ class PathTest < Imgix::Test
   end
 
   def test_resetting_defaults
-    url = 'http://demo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e'
+    url = 'https://demo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e'
     path = client.path('/images/demo.png')
     path.height = 300
 
@@ -32,7 +32,7 @@ class PathTest < Imgix::Test
   end
 
   def test_path_with_multiple_params
-    url = 'http://demo.imgix.net/images/demo.png?h=200&w=200&s=d570a1ecd765470f7b34a69b56718a7a'
+    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)
@@ -42,7 +42,7 @@ class PathTest < Imgix::Test
   end
 
   def test_path_with_multi_value_param_safely_encoded
-    url = 'http://demo.imgix.net/images/demo.png?markalign=middle%2Ccenter&s=f0d0e28a739f022638f4ba6dddf9b694'
+    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
@@ -53,8 +53,16 @@ class PathTest < Imgix::Test
   end
 
   def test_token_is_optional
-    client = Imgix::Client.new(host: 'demo.imgix.net', :include_library_param => false)
-    url = 'http://demo.imgix.net/images/demo.png?'
+    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
@@ -63,12 +71,12 @@ class PathTest < Imgix::Test
   def test_full_url
     path = 'https://google.com/cats.gif'
 
-    assert_equal "http://demo.imgix.net/#{CGI.escape(path)}?&s=4c3ff935011f0d2251800e6a2bb68ee5", client.path(path).to_url
+    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 "http://demo.imgix.net/#{CGI.escape(path)}?&s=8943817bed50811f6ceedd8f4b84169d", client.path(path).to_url
+    assert_equal "https://demo.imgix.net/#{CGI.escape(path)}?s=35ca40e2e7b6bd208be2c4f7073f658e", client.path(path).to_url
   end
 
   def test_include_library_param
@@ -90,6 +98,6 @@ class PathTest < Imgix::Test
 private
 
   def client
-    @client ||= Imgix::Client.new(:host => 'demo.imgix.net', :token => '10adc394', :include_library_param => false)
+    @client ||= Imgix::Client.new(host: 'demo.imgix.net', secure_url_token: '10adc394', include_library_param: false)
   end
 end

data/test/units/url_test.rb

@@ -1,27 +1,36 @@
 require 'test_helper'
 
 class UrlTest < Imgix::Test
+  DEMO_IMAGE_PATH = '/images/demo.png'
+
   def test_signing_with_no_params
-    path = '/images/demo.png'
-    assert_equal 'http://demo.imgix.net/images/demo.png?&s=3c1d676d4daf28c044dd83e8548f834a', client.sign_path(path)
+    path = client.path(DEMO_IMAGE_PATH)
+
+    assert_equal 'https://demo.imgix.net/images/demo.png?s=2c7c157eaf23b06a0deb2f60b81938c4', path.to_url
   end
 
   def test_signing_with_one
-    path = '/images/demo.png?w=200'
-    assert_equal 'http://demo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e', client.sign_path(path)
+    path = client.path(DEMO_IMAGE_PATH)
+    path.width = 200
+
+    assert_equal 'https://demo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e', path.to_url
   end
 
   def test_signing_with_multiple_params
-    path = '/images/demo.png?h=200&w=200'
-    assert_equal 'http://demo.imgix.net/images/demo.png?h=200&w=200&s=d570a1ecd765470f7b34a69b56718a7a', client.sign_path(path)
+    path = client.path(DEMO_IMAGE_PATH)
+    path.height = 200
+    path.width = 200
+    assert_equal 'https://demo.imgix.net/images/demo.png?h=200&w=200&s=d570a1ecd765470f7b34a69b56718a7a', path.to_url
 
-    path = '/images/demo.png?w=200&h=200'
-    assert_equal 'http://demo.imgix.net/images/demo.png?w=200&h=200&s=00b5cde5c7b8bca8618cb911da4ac379', client.sign_path(path)
+    path = client.path(DEMO_IMAGE_PATH)
+    path.width = 200
+    path.height = 200
+    assert_equal 'https://demo.imgix.net/images/demo.png?w=200&h=200&s=00b5cde5c7b8bca8618cb911da4ac379', path.to_url
   end
 
 private
 
   def client
-    @client ||= Imgix::Client.new(:host => 'demo.imgix.net', :token => '10adc394', :include_library_param => false)
+    @client ||= Imgix::Client.new(host: 'demo.imgix.net', secure_url_token: '10adc394', include_library_param: false)
   end
 end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Kelly Sutton
 - Sam Soffes
 - Ryan LeFevre
 - Antony Denyer
+- Paul Straw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -27,12 +28,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Easily sign imgix URLs.
+description: Easily create and sign imgix URLs.
 email:
 - kelly@imgix.com
 - sam@soff.es
 - ryan@layervault.com
 - email@antonydenyer.co.uk
+- paul@imgix.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -75,10 +77,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Unofficial Ruby Gem for easily signing imgix URLs.
+summary: Official Ruby Gem for easily creating and signing imgix URLs.
 test_files:
 - test/test_helper.rb
 - test/units/domains_test.rb