imageproxy 0.1.0

data/imageproxy.rb

@@ -0,0 +1,4 @@
+require 'cgi'
+require 'mime/types'
+Bundler.require :default
+

data/lib/command.rb

@@ -0,0 +1,22 @@
+class Command
+  protected
+
+  def execute_command(command_line)
+    stdin, stdout, stderr = Open3.popen3(command_line)
+    [output_to_string(stdout), output_to_string(stderr)].join("")
+  end
+
+  def curl(url, options={})
+    user_agent = options[:user_agent] || "imageproxy"
+    %|curl -s -A "#{user_agent}" "#{url}"|
+  end
+
+  def to_path(obj)
+    obj.respond_to?(:path) ? obj.path : obj.to_s
+  end
+
+  def output_to_string(output)
+    output.readlines.join("").chomp
+  end
+
+end

data/lib/compare.rb

@@ -0,0 +1,12 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "command")
+
+class Compare < Command
+  def initialize(a, b)
+    @path_a = to_path(a)
+    @path_b = to_path(b)
+  end
+
+  def execute
+    execute_command %'compare -metric AE -fuzz 10% "#{@path_a}" "#{@path_b}" "#{Tempfile.new("compare").path}"'
+  end
+end

data/lib/convert.rb

@@ -0,0 +1,72 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "command")
+
+class Convert < Command
+  attr_reader :options
+  
+  def initialize(options)
+    @options = options
+    if (!(options.resize || options.thumbnail || options.rotate || options.flip || options.format || options.quality))
+      raise "Missing action or illegal parameter value"
+    end
+  end
+
+  def execute(user_agent=nil)
+    execute_command %'#{curl options.source, :user_agent => user_agent} | convert - #{convert_options} #{new_format}#{file.path}'
+    file
+  end
+
+  def convert_options
+    convert_options = []
+    convert_options << "-resize #{resize_thumbnail_options(options.resize)}" if options.resize
+    convert_options << "-thumbnail #{resize_thumbnail_options(options.thumbnail)}" if options.thumbnail
+    convert_options << "-flop" if options.flip == "horizontal"
+    convert_options << "-flip" if options.flip == "vertical"
+    convert_options << rotate_options if options.rotate
+    convert_options << "-colors 256" if options.format == "png8"
+    convert_options << "-quality #{options.quality}" if options.quality
+    convert_options << interlace_options if options.progressive
+    convert_options.join " "
+  end
+
+  def resize_thumbnail_options(size)
+    case options.shape
+      when "cut"
+        "#{size}^ -gravity center -extent #{size}"
+      when "preserve"
+        size
+      when "pad"
+        background = options.background ? %|"#{options.background}"| : %|none -matte|
+        "#{size} -background #{background} -gravity center -extent #{size}"
+      else
+        size
+    end
+  end
+
+  def rotate_options
+    if options.rotate.to_f % 90 == 0
+      "-rotate #{options.rotate}"
+    else
+      background = options.background ? %|"#{options.background}"| : %|none|
+      "-background #{background} -matte -rotate #{options.rotate}"
+    end
+  end
+
+  def interlace_options
+    case options.progressive
+      when "true"
+        "-interlace JPEG"
+      when "false"
+        "-interlace none"
+      else
+        ""
+    end
+  end
+
+  def new_format
+    options.format ? "#{options.format}:" : ""
+  end
+
+  def file
+    @tempfile ||= Tempfile.new("imageproxy").tap(&:close)
+  end
+end

data/lib/identify.rb

@@ -0,0 +1,11 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "command")
+
+class Identify < Command
+  def initialize(options)
+    @options = options
+  end
+
+  def execute(user_agent=nil)
+    execute_command %'#{curl @options.source, :user_agent => user_agent} | identify -verbose -'
+  end
+end

data/lib/options.rb

@@ -0,0 +1,73 @@
+require 'uri'
+require 'cgi'
+require 'mime/types'
+
+class Options
+  def initialize(path, query_params)
+    params_from_path = path.split('/').reject { |s| s.nil? || s.empty? }
+    command = params_from_path.shift
+
+    @hash = Hash[*params_from_path]
+    @hash['command'] = command
+    @hash.merge! query_params
+    merge_obfuscated
+    @hash["source"] = @hash.delete("src") if @hash.has_key?("src")
+    
+    unescape_source
+    unescape_signature
+    check_parameters
+  end
+
+  def check_parameters
+    check_param('resize',/^[0-9]{1,5}(x[0-9]{1,5})?$/)
+    check_param('thumbnail',/^[0-9]{1,5}(x[0-9]{1,5})?$/)
+    check_param('rotate',/^(-)?[0-9]{1,3}(\.[0-9]+)?$/)
+    check_param('format',/^[0-9a-zA-Z]{2,6}$/)
+    check_param('progressive',/^true|false$/i)
+    check_param('background',/^#[0-9a-f]{3}([0-9a-f]{3})?|rgba\([0-9]{1,3},[0-9]{1,3},[0-9]{1,3},[0-1](.[0-9]+)?\)$/)
+    check_param('shape',/^preserve|pad|cut$/i)
+    @hash['quality'] = [[@hash['quality'].to_i, 100].min, 0].max.to_s if @hash.has_key?('quality')
+  end
+
+  def check_param(param, rega)
+    if @hash.has_key? param
+      if (! rega.match(@hash[param]))
+        @hash.delete(param)
+      end
+    end
+  end
+
+  def method_missing(symbol)
+    @hash[symbol.to_s] || @hash[symbol]
+  end
+
+  def content_type
+    MIME::Types.of(@hash['source']).first.content_type
+  end
+
+  private
+  
+  def unescape_source
+    @hash['source'] &&= CGI.unescape(CGI.unescape(@hash['source']))
+  end
+
+  def unescape_signature
+    @hash['signature'] &&= URI.unescape(@hash['signature'])
+  end
+
+  def merge_obfuscated
+    if @hash["_"]
+      decoded = Base64.decode64(CGI.unescape(@hash["_"]))
+      decoded_hash = CGI.parse(decoded)
+      @hash.delete "_"
+      decoded_hash.map { |k, v| @hash[k] = (v.class == Array) ? v.first : v }
+    end
+
+    if @hash["-"]
+      decoded = Base64.decode64(CGI.unescape(@hash["-"]))
+      decoded_hash = Hash[*decoded.split('/').reject { |s| s.nil? || s.empty? }]
+      @hash.delete "-"
+      decoded_hash.map { |k, v| @hash[k] = (v.class == Array) ? v.first : v }
+    end
+  end
+end

data/lib/selftest.rb

@@ -0,0 +1,72 @@
+class Selftest
+  def self.html(request, signature_required, signature_secret)
+    html = <<-HTML
+      <html>
+        <head>
+          <title>imageproxy selftest</title>
+          <style type="text/css">
+            body { background: url(/background.png); font-family: "Helvetica", sans-serif; font-size: smaller; }
+            h3 { margin: 2em 0 0 0; }
+            img { display: block; border: 1px solid black; margin: 1em 0; }
+            .footer { margin-top: 2em; border-top: 1px solid #999; padding-top: 0.5em; font-size: smallest; }
+          </style>
+        </head>
+        <body>
+    HTML
+
+    url_prefix = "#{request.scheme}://#{request.host_with_port}"
+    raw_source = "http://eahanson.s3.amazonaws.com/imageproxy/sample.png"
+    source = CGI.escape(URI.escape(URI.escape(raw_source)))
+
+    html += <<-HTML
+      <h3>Original Image</h3>
+      <a href="#{raw_source}">#{raw_source}</a>
+      <img src="#{raw_source}">
+    HTML
+
+    examples = [
+      ["Resize (regular query-string URL format)", "/convert?resize=100x100&source=#{source}"],
+      ["Resize (CloudFront-compatible URL format)", "/convert/resize/100x100/source/#{source}"],
+
+      ["Resize with padding", "/convert?resize=100x100&shape=pad&source=#{source}"],
+      ["Resize with padding & background color", "/convert?resize=100x100&shape=pad&background=%23ff00ff&source=#{source}"],
+
+      ["Resize with cutting", "/convert?resize=100x100&shape=cut&source=#{source}"],
+
+      ["Flipping horizontally", "/convert?flip=horizontal&source=#{source}"],
+      ["Flipping vertically", "/convert?flip=vertical&source=#{source}"],
+
+      ["Rotating to a 90-degree increment", "/convert?rotate=90&source=#{source}"],
+      ["Rotating to a non-90-degree increment", "/convert?rotate=120&source=#{source}"],
+      ["Rotating to a non-90-degree increment with a background color", "/convert?rotate=120&background=%23ff00ff&source=#{source}"],
+
+      ["Combo", "/convert?resize=100x100&shape=cut&rotate=45&background=%23ff00ff&source=#{source}"]
+    ]
+
+    examples.each do |example|
+      path = example[1]
+      if (signature_required)
+        signature = CGI.escape(Signature.create(path, signature_secret))
+        if path.include?("&")
+          path += "&signature=#{signature}"
+        else
+          path += "/signature/#{signature}"
+        end
+      end
+      example_url = url_prefix + path
+      html += <<-HTML
+        <h3>#{example[0]}</h3>
+        <a href="#{example_url}">#{example_url}</a>
+        <img src="#{example_url}">
+      HTML
+    end
+
+    html += <<-HTML
+          <div class="footer"><a href="https://github.com/eahanson/imageproxy">imageproxy</a> selftest</div>
+        </body>
+      </html>
+    HTML
+
+    html
+  end
+end

data/lib/server.rb

@@ -0,0 +1,105 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "options")
+require File.join(File.expand_path(File.dirname(__FILE__)), "convert")
+require File.join(File.expand_path(File.dirname(__FILE__)), "identify")
+require File.join(File.expand_path(File.dirname(__FILE__)), "selftest")
+require File.join(File.expand_path(File.dirname(__FILE__)), "signature")
+require 'uri'
+
+class Server
+  def initialize
+    @file_server = Rack::File.new(File.join(File.expand_path(File.dirname(__FILE__)), "..", "public"))
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+    options = Options.new(request.path_info, request.params)
+    user_agent = request.env["HTTP_USER_AGENT"]
+    cachetime = config(:cache_time) ? config(:cache_time) : 86400
+
+    case options.command
+      when "convert", "process", nil
+        check_signature request, options
+        check_domain options
+        check_size options
+
+        file = Convert.new(options).execute(user_agent)
+        class << file
+          alias to_path path
+        end
+
+        file.open
+        [200, {"Content-Type" => options.content_type, "Cache-Control" => "max-age=#{cachetime}, must-revalidate"}, file]
+      when "identify"
+        check_signature request, options
+        check_domain options
+
+        [200, {"Content-Type" => "text/plain"}, [Identify.new(options).execute(user_agent)]]
+      when "selftest"
+        [200, {"Content-Type" => "text/html"}, [Selftest.html(request, config?(:signature_required), config(:signature_secret))]]
+      else
+        @file_server.call(env)
+    end
+  rescue
+    STDERR.puts $!
+    [500, {"Content-Type" => "text/plain"}, ["Error (#{$!})"]]
+  end
+
+  private
+
+  def config(symbol)
+    ENV["IMAGEPROXY_#{symbol.to_s.upcase}"]
+  end
+
+  def config?(symbol)
+    config(symbol) && config(symbol).casecmp("TRUE") == 0
+  end
+
+  def check_signature(request, options)
+    if config?(:signature_required)
+      raise "Missing siganture" if options.signature.nil?
+
+      valid_signature = Signature.correct?(options.signature, request.fullpath, config(:signature_secret))
+      raise "Invalid signature #{options.signature} for #{request.url}" unless valid_signature
+    end
+  end
+
+  def check_domain(options)
+    raise "Invalid domain" unless domain_allowed? options.source
+  end
+
+  def check_size(options)
+    raise "Image size too large" if exceeds_max_size(options.resize, options.thumbnail)
+  end  
+
+  def domain_allowed?(url)
+    return true unless allowed_domains
+    allowed_domains.include?(url_to_domain url)
+  end
+
+  def url_to_domain(url)
+    URI::parse(url).host.split(".")[-2, 2].join(".")
+  rescue
+    ""
+  end
+
+  def allowed_domains
+    config(:allowed_domains) && config(:allowed_domains).split(",").map(&:strip)
+  end
+
+  def exceeds_max_size(*sizes)
+    max_size && sizes.any? { |size| size && requested_size(size) > max_size }
+  end
+
+  def max_size
+    config(:max_size) && config(:max_size).to_i
+  end
+
+  def requested_size(req_size)
+    sizes = req_size.scan(/\d*/)
+    if sizes[2] && (sizes[2].to_i > sizes[0].to_i)
+      sizes[2].to_i
+    else
+      sizes[0].to_i
+    end
+  end
+end

data/lib/signature.rb

@@ -0,0 +1,24 @@
+require 'base64'
+require 'openssl'
+
+class Signature
+  def self.create(path, secret)
+    Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), secret, remove_signature_from(path))).strip.tr('+/', '-_')
+  end
+
+  def self.remove_signature_from(path)
+    #TODO: do this in fewer passes
+    path.
+      sub(%r{&signature(=[^&]*)?(?=&|$)}, "").
+      sub(%r{\?signature(=[^&]*)?&}, "?").
+      sub(%r{\?signature(=[^&]*)?$}, "").
+      sub(%r{/signature/[^\?/]+/}, "/").
+      sub(%r{/signature/[^\?/]+\?}, "?").
+      sub(%r{/signature/[^\?/]+}, "")
+  end
+
+  def self.correct?(signature, path, secret)
+    created = create(path, secret)
+    signature != nil && path != nil && secret != nil && (created == signature || created == signature.tr('+/', '-_'))
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Command do
+  describe "#curl" do
+    context "when a user agent is supplied" do
+      it "should send that user agent" do
+        Command.new.send(:curl, "http://example.com/dog.jpg", :user_agent => "some user agent").should ==
+          %|curl -s -A "some user agent" "http://example.com/dog.jpg"|
+      end
+    end
+
+    context "when no user agent is supplied" do
+      it "should send a default user agent" do
+        Command.new.send(:curl, "http://example.com/dog.jpg").should ==
+          %|curl -s -A "imageproxy" "http://example.com/dog.jpg"|
+      end
+    end
+  end
+end

data/spec/convert_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+describe Convert do
+  before do
+    @mock_file = mock("file")
+    @mock_file.stub!(:path).and_return("/mock/file/path")
+  end
+
+  def command(options)
+    command = Convert.new(Options.new("", {:source => "http%3A%2F%2Fexample.com%2Fdog.jpg"}.merge(options)))
+    command.stub!(:file).and_return(@mock_file)
+    command.stub!(:system)
+    command
+  end
+
+  context "general" do
+    before do
+      @command = Convert.new(Options.new("/convert/format/png/resize/10x20/source/http%3A%2F%2Fexample.com%2Fdog.jpg", {}))
+      @command.stub!(:file).and_return(@mock_file)
+      @command.stub!(:system)
+    end
+
+    it "should generate the proper command-line" do
+      @command.should_receive(:execute_command).with(%'curl -s -A "imageproxy" "http://example.com/dog.jpg" | convert - -resize 10x20 png:/mock/file/path')
+      @command.execute
+    end
+
+    it "should return the output file" do
+      @command.stub!(:execute_command)
+      @command.execute.should == @mock_file
+    end
+  end
+
+  context "when resizing" do
+    it("with no extra args") do
+      command(:resize => "10x20").convert_options.should ==
+        '-resize 10x20'
+    end
+
+    it("with a different size") do
+      command(:resize => "50x50").convert_options.should ==
+        '-resize 50x50'
+    end
+
+    it("when preserving shape") do
+      command(:resize => "10x20", :shape => "preserve").convert_options.should ==
+        '-resize 10x20'
+    end
+
+    it("when padding") do
+      command(:resize => "10x20", :shape => "pad").convert_options.should ==
+        '-resize 10x20 -background none -matte -gravity center -extent 10x20'
+    end
+
+    it("when padding with a background color") do
+      command(:resize => "10x20", :shape => "pad", :background => "#ff00ff").convert_options.should ==
+        '-resize 10x20 -background "#ff00ff" -gravity center -extent 10x20'
+    end
+
+    it("when cutting") do
+      command(:resize => "10x20", :shape => "cut").convert_options.should ==
+        '-resize 10x20^ -gravity center -extent 10x20'
+    end
+  end
+
+  context "when thumbnailing" do
+    it("when preserving shape") do
+      command(:thumbnail => "10x20", :shape => "preserve").convert_options.should ==
+        '-thumbnail 10x20'
+    end
+
+    it("when padding") do
+      command(:thumbnail => "10x20", :shape => "pad", :background => "#ff00ff").convert_options.should ==
+        '-thumbnail 10x20 -background "#ff00ff" -gravity center -extent 10x20'
+    end
+
+    it("when cutting") do
+      command(:thumbnail => "10x20", :shape => "cut").convert_options.should ==
+        '-thumbnail 10x20^ -gravity center -extent 10x20'
+    end
+  end
+
+  context "when flipping" do
+    it("should flip horizontal") do
+      command(:flip => "horizontal").convert_options.should ==
+        "-flop"
+    end
+
+    it("should flip vertical") do
+      command(:flip => "vertical").convert_options.should ==
+        "-flip"
+    end
+  end
+
+  context "when rotating" do
+    it("should rotate to a right angle") do
+      command(:rotate => "90").convert_options.should ==
+        "-rotate 90"
+    end
+
+    it("should rotate to a non-right angle") do
+      command(:rotate => "92.1").convert_options.should ==
+        "-background none -matte -rotate 92.1"
+    end
+
+    it("should rotate to a non-right angle with a background") do
+      command(:rotate => "92.1", :background => "#ff00ff").convert_options.should ==
+        '-background "#ff00ff" -matte -rotate 92.1'
+    end
+  end
+
+  context "when changing format" do
+    it("should not change the format if not requested") do
+      command(:rotate => "90").new_format.should ==
+        ""
+    end
+
+    it("should not change the format if not requested") do
+      command(:rotate => "90", :format => "png").new_format.should ==
+        "png:"
+    end
+
+    it("should set the colors when converting to png8") do
+      command(:rotate => "90", :format => "png8").convert_options.should ==
+        "-rotate 90 -colors 256"
+    end
+  end
+
+  context "when changing quality" do
+    it("should set the quality") do
+      command(:quality => "85").convert_options.should ==
+        "-quality 85"
+    end
+  end
+
+  context "when converting to progressive" do
+    it("should be 'JPEG' if progressive is 'true'") do
+      command(:resize => "10x10", :progressive => "true").convert_options.should ==
+        "-resize 10x10 -interlace JPEG"
+    end
+
+    it("should be 'none' if progressive is 'false'") do
+      command(:resize => "10x10", :progressive => "false").convert_options.should ==
+        "-resize 10x10 -interlace none"
+    end
+
+    it("should not be set if progressive isn't supplied") do
+      command({:resize => "10x10"}).convert_options.should_not match /interlace/
+    end
+  end
+end