imgix 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 588ae10e0524aac623bad42329e59ab645891c9d
-  data.tar.gz: 836a1ed328300c1d74ae6919d720acfef0aa373f
+  metadata.gz: 54d696fed267d139643d66d0feec9639b5c71b10
+  data.tar.gz: 909c82a553d42a2b257ca3b80a08e2109868dc9a
 SHA512:
-  metadata.gz: 20e0097bd2e1671598a26c3b70c85aac692ce4edef1615a33e888154d8011b394aac06d39e750abe4ffc58f9c818543dc10213a01e0334a623d0abf9ccead82a
-  data.tar.gz: 3aab4814449a24f6b2aeca5ac07158dbccd286114563e11a1a52b4f139e477fd2ab14382c509485412da99641125cbe7510427e5954f34dd3ad3f22280bbdd73
+  metadata.gz: d17c57373d186ca4309b4f446c107ed3f3bf773d97901999f6fe21d6540affea4f6a19e572f3625a998df3efd6999a602cc1300bedfbe7991706f903eae798cd
+  data.tar.gz: b7505c7519afd3b3ee52bf55c27bba6d8f19f58a70f654d0a19895547aeac35b0365dca686ab5d39f687025f082347b357276c6f2124ccb7a0995d3959256459

data/{Readme.markdown → README.md}

@@ -1,6 +1,6 @@
 # Imgix
 
-Unofficial Ruby Gem for signing [imgix](http://imgix.com) URLs. Tested under 1.9.2, 2.2.1, JRuby 1.7.19, and Rubinius 2.2.7.
+Official Ruby Gem for signing [imgix](http://imgix.com) URLs. Tested under 1.9.2, 2.2.2, JRuby 1.7.19, and Rubinius 2.2.7.
 
 [![Build Status](https://travis-ci.org/imgix/imgix-rb.png?branch=master)](https://travis-ci.org/imgix/imgix-rb)
 
@@ -82,11 +82,19 @@ For example to use the [noise reduction](http://www.imgix.com/docs/urlapi/enhanc
 path.noise_reduction(50,50)
 ```
 
-
 ## URL encoding and signed ImgIX URLs
 
 Some important third parties (like Facebook) apply URL escaping to query string components, which can cause correctly signed ImgIX URLs to to be transformed into incorrectly signed ones. We URL encode the query part of the URL before signing, so you don't have to worry about this.
 
+## What is the `ixlib` param on every request?
+
+For security and diagnostic purposes, we sign all requests with the language and version of library used to generate the URL.
+
+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 })
+```
 
 ## Contributing
 

data/lib/imgix/client.rb

@@ -13,10 +13,13 @@ module Imgix
       @token = options[:token]
       @secure = options[:secure]
       @shard_strategy = options[:shard_strategy] and validate_strategy!
+      @include_library_param = options.fetch(:include_library_param, true)
     end
 
     def path(path)
-      Path.new(prefix(path), @token, path)
+      p = Path.new(prefix(path), @token, path)
+      p.ixlib("rb-#{Imgix::VERSION}") if @include_library_param
+      p
     end
 
     def prefix(path)

data/lib/imgix/version.rb

@@ -1,3 +1,3 @@
 module Imgix
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/test/units/domains_test.rb

@@ -8,7 +8,8 @@ class DomainsTest < Imgix::Test
         "demos-2.imgix.net",
         "demos-3.imgix.net",
       ],
-      :token => '10adc394')
+      :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
@@ -24,7 +25,8 @@ class DomainsTest < Imgix::Test
         "demos-3.imgix.net",
       ],
       :token => '10adc394',
-      :shard_strategy => :cycle)
+      :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
@@ -42,7 +44,8 @@ class DomainsTest < Imgix::Test
   def test_strips_out_protocol
     client = Imgix::Client.new(:host =>
         "http://demos-1.imgix.net",
-        :token => '10adc394')
+        :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
@@ -55,7 +58,8 @@ class DomainsTest < Imgix::Test
         "demos-3.imgix.net",
       ],
       :token => '10adc394',
-      :shard_strategy => :cycle)
+      :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

data/test/units/path_test.rb

@@ -53,7 +53,7 @@ class PathTest < Imgix::Test
   end
 
   def test_token_is_optional
-    client = Imgix::Client.new(host: 'demo.imgix.net')
+    client = Imgix::Client.new(host: 'demo.imgix.net', :include_library_param => false)
     url = 'http://demo.imgix.net/images/demo.png?'
     path = client.path('/images/demo.png')
 
@@ -71,9 +71,16 @@ class PathTest < Imgix::Test
     assert_equal "http://demo.imgix.net/#{CGI.escape(path)}?&s=8943817bed50811f6ceedd8f4b84169d", 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
+
 private
 
   def client
-    @client ||= Imgix::Client.new(:host => 'demo.imgix.net', :token => '10adc394')
+    @client ||= Imgix::Client.new(:host => 'demo.imgix.net', :token => '10adc394', :include_library_param => false)
   end
 end

data/test/units/url_test.rb

@@ -22,6 +22,6 @@ class UrlTest < Imgix::Test
 private
 
   def client
-    @client ||= Imgix::Client.new(:host => 'demo.imgix.net', :token => '10adc394')
+    @client ||= Imgix::Client.new(:host => 'demo.imgix.net', :token => '10adc394', :include_library_param => false)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Sam Soffes
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -41,8 +41,8 @@ files:
 - Contributing.markdown
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
-- Readme.markdown
 - imgix.gemspec
 - lib/imgix.rb
 - lib/imgix/client.rb
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Unofficial Ruby Gem for easily signing imgix URLs.