imgix 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6d90cf96e4d279cd74ac1c314f817036597834c
-  data.tar.gz: a58e16f0256b02092964d89e2ccc094241ff76f0
+  metadata.gz: e7a5b61019c7034e4cab71bccb1506e50523b529
+  data.tar.gz: 1fd4f9a95023c58150c616885344659b44d804b5
 SHA512:
-  metadata.gz: 1a9b59a69fddf83c0a3ed7ebc47470cbe1f33deb25422831973af740d1290852a1a583ecb76445da478040e9684e01af8d0a00620f895681e2987851c9b4a579
-  data.tar.gz: 5460ef4d06d0d786e8ea902a18c2c13f7c16c60344c16e01e605e39baec7f71d37cf726bc2fdc5ba36185ec5531eb5d0379b2eac0e9780a097b645c7f6ef3def
+  metadata.gz: e60eccc4c267a7cc96fde4b251c5156b30539b8be3a7397785138902e389efcb08b52e4542926895c83b2feeb5764dfa7e44d59917500306fafb01a1333ca83b
+  data.tar.gz: 8fff63eb037dd4c223b2e4e6ec6e24c27a1cc398d7cc8bb79ebdb6b3249366b9d5bf7fa1464532e3cce5403bf1618117e88508839d19932f1300b5c9a8b5267f

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/Contributing.markdown

@@ -0,0 +1,19 @@
+## Submitting a Pull Request
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add tests for your unimplemented feature or bug fix.
+4. Run `bundle exec rake`. If your tests pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake`. If your tests fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake doc`. If your changes are not 100% documented, go
+   back to step 8.
+10. Add, commit, and push your changes.
+11. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Rakefile

@@ -5,4 +5,4 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
 end
-task default: :test
+task :default => :test

data/Readme.markdown

@@ -1,6 +1,7 @@
 # Imgix
 
-Ruby Gem for signing [imgix](http://imgix.com) URLs.
+Unofficial Ruby Gem for signing [imgix](http://imgix.com) URLs.
+
 
 ## Installation
 
@@ -16,18 +17,42 @@ Or install it yourself as:
 
     $ gem install imgix
 
+
 ## Usage
 
+Simply initialize a client with a host and your token. You can optionally generate secure URLs.
+
+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.
+
 ``` ruby
-client = Imgix::Client.new(host: 'your-subdomain.imgix.net', token: 'your-token', secure: true)
+client = Imgix::Client.new(:host => 'your-subdomain.imgix.net', :token => 'your-token', :secure => true)
+
 client.sign_path('/images/demo.png?w=200')
-#=> http://foo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e
+#=> https://your-subdomain.imgix.net/images/demo.png?w=200&s=2eadddacaa9bba4b88900d245f03f51e
+
+# OR
+client.path('/images/demo.png').to_url(w: 200)
+
+# OR
+path = client.path('/images/demo.png')
+path.width = 200
+path.to_url
+
+# OR
+client.path('/images/demo.png').width(200).height(300).to_url
+
+# Some other tricks
+path.defaults.width(300).to_url # Resets parameters
+path.rect(x: 0, y: 50, width: 200, height: 300).to_url # Rect helper
 ```
 
+## 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).
+
+[![Build Status](https://travis-ci.org/soffes/imgix-rb.png?branch=master)](https://travis-ci.org/soffes/imgix-rb)
+
+
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+See the [contributing guide](Contributing.markdown).

data/imgix.gemspec

@@ -6,11 +6,11 @@ require 'imgix/version'
 Gem::Specification.new do |spec|
   spec.name          = 'imgix'
   spec.version       = Imgix::VERSION
-  spec.authors       = ['Sam Soffes']
-  spec.email         = ['sam@soff.es']
+  spec.authors       = ['Sam Soffes', 'Ryan LeFevre']
+  spec.email         = ['sam@soff.es', 'ryan@layervault.com']
   spec.description   = 'Easily sign imgix URLs.'
-  spec.summary       = spec.description
-  spec.homepage      = 'https://github.com/soffes/imgix'
+  spec.summary       = 'Unofficial Ruby Gem for easily signing imgix URLs.'
+  spec.homepage      = 'https://github.com/soffes/imgix-rb'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 1.8.7'
+  spec.required_ruby_version = '>= 1.9.0'
   spec.add_dependency 'addressable'
 end

data/lib/imgix.rb

@@ -1,5 +1,6 @@
 require 'imgix/version'
 require 'imgix/client'
+require 'imgix/path'
 
 module Imgix
 end

data/lib/imgix/client.rb

@@ -6,7 +6,15 @@ module Imgix
     def initialize(options = {})
       @host = options[:host]
       @token = options[:token]
-      @secure = options[:secure]
+      @secure = options[:secure] || false
+    end
+
+    def path(path)
+      Path.new(prefix, @token, path)
+    end
+
+    def prefix
+      "#{@secure ? 'https' : 'http'}://#{@host}"
     end
 
     def sign_path(path)

data/lib/imgix/param_helpers.rb

@@ -0,0 +1,16 @@
+module Imgix
+  module ParamHelpers
+    def rect(position)
+      @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/lib/imgix/path.rb

@@ -0,0 +1,91 @@
+require 'imgix/param_helpers'
+
+module Imgix
+  class Path
+    include ParamHelpers
+
+    ALIASES = {
+      width:           :w,
+      height:          :h,
+      rotation:        :rot,
+      noise_reduction: :nr,
+      sharpness:       :sharp,
+      exposure:        :exp,
+      vibrance:        :vib,
+      saturation:      :sat,
+      brightness:      :bri,
+      contrast:        :con,
+      highlight:       :high,
+      shadow:          :shad,
+      gamma:           :gam,
+      pixelate:        :px,
+      halftone:        :htn,
+      watermark:       :mark,
+      text:            :txt,
+      format:          :fm,
+      quality:         :q
+    }
+
+    def initialize(prefix, token, path = '/')
+      @prefix = prefix
+      @token = token
+      @path = path
+      @options = {}
+
+      @path = "/#{@path}" if @path[0] != '/'
+    end
+
+    def to_url(opts={})
+      prev_options = @options.dup
+      @options.merge!(opts)
+      
+      url = @prefix + path_and_params
+      url += (@options.length > 0 ? '&' : '') + "s=#{signature}"
+
+      @options = prev_options
+      return url
+    end
+
+    def defaults
+      @options = {}
+      return self
+    end
+
+    def method_missing(method, *args, &block)
+      key = method.to_s.gsub('=', '')
+      if args.length == 0
+        return @options[key]
+      elsif args.first.nil? && @options.has_key?(key)
+        @options.delete(key) and return self
+      end
+
+      @options[key] = args.join(',')
+      return self
+    end
+
+    ALIASES.each do |from, to|
+      define_method from do |*args|
+        self.send(to, *args)
+      end
+
+      define_method "#{from}=" do |*args|
+        self.send("#{to}=", *args)
+        return self
+      end
+    end
+
+    private
+
+    def signature      
+      Digest::MD5.hexdigest(@token + @path + '?' + query)
+    end
+
+    def path_and_params
+      "#{@path}?#{query}"
+    end
+
+    def query
+      @options.map { |k, v| "#{k.to_s}=#{v}" }.join('&')
+    end
+  end
+end

data/lib/imgix/version.rb

@@ -1,3 +1,3 @@
 module Imgix
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/test/units/path_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class UrlTest < 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
+
+    path = client.path('images/demo.png')
+    assert_equal 'http://demo.imgix.net/images/demo.png?s=3c1d676d4daf28c044dd83e8548f834a', path.to_url
+  end
+
+  def test_signing_path_with_param
+    url = 'http://demo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e'
+    path = client.path('/images/demo.png')
+    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_equal url, path.width(200).to_url
+  end
+
+  def test_resetting_defaults
+    url = 'http://demo.imgix.net/images/demo.png?w=200&s=da421114ca238d1f4a927b889f67c34e'
+    path = client.path('/images/demo.png')
+    path.height = 300
+
+    assert_equal url, path.defaults.to_url(w: 200)
+  end
+
+  def test_path_with_multiple_params
+    url = 'http://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_equal url, path.height(200).width(200).to_url
+  end
+
+private
+
+  def client
+    @client ||= Imgix::Client.new(:host => 'demo.imgix.net', :token => '10adc394')
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Soffes
+- Ryan LeFevre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -27,11 +28,14 @@ dependencies:
 description: Easily sign imgix URLs.
 email:
 - sam@soff.es
+- ryan@layervault.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- Contributing.markdown
 - Gemfile
 - LICENSE
 - Rakefile
@@ -39,10 +43,13 @@ 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/path_test.rb
 - test/units/url_test.rb
-homepage: https://github.com/soffes/imgix
+homepage: https://github.com/soffes/imgix-rb
 licenses:
 - MIT
 metadata: {}
@@ -54,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -65,7 +72,8 @@ rubyforge_project:
 rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: Easily sign imgix URLs.
+summary: Unofficial Ruby Gem for easily signing imgix URLs.
 test_files:
 - test/test_helper.rb
+- test/units/path_test.rb
 - test/units/url_test.rb