image_vise 0.0.16

data/spec/image_vise/render_engine_spec.rb

@@ -0,0 +1,167 @@
+require_relative '../spec_helper'
+require 'rack/test'
+
+describe ImageVise::RenderEngine do
+  include Rack::Test::Methods
+  
+  let(:app) { ImageVise::RenderEngine.new }
+
+  context 'when the subclass is configured to raise exceptions' do
+    after :each do
+      ImageVise.reset_allowed_hosts!
+      ImageVise.reset_secret_keys!
+    end
+    
+    it 'raises an exception instead of returning an error response' do
+      class << app
+        def raise_exceptions?
+          true
+        end
+      end
+      
+      p = ImageVise::Pipeline.new.crop(width: 10, height: 10, gravity: 'c')
+      image_request = ImageVise::ImageRequest.new(src_url: 'http://unknown.com/image.jpg', pipeline: p)
+      params = image_request.to_query_string_params('l33tness')
+      expect(app).to receive(:handle_generic_error).and_call_original
+      expect {
+        get '/', params
+      }.to raise_error(/No keys set/)
+    end
+  end
+
+  context 'when requesting an image' do
+    after :each do
+      ImageVise.reset_allowed_hosts!
+      ImageVise.reset_secret_keys!
+    end
+    
+    context 'halts with 422' do
+      before :each do
+        parsed_url = Addressable::URI.parse(public_url)
+        ImageVise.add_allowed_host!(parsed_url.host)
+      end
+
+      it 'when the requested image cannot be opened by ImageMagick' do
+        uri = Addressable::URI.parse(public_url)
+        ImageVise.add_allowed_host!(uri.host)
+        ImageVise.add_secret_key!('l33tness')
+        uri.path = '/___nonexistent_image.jpg'
+        
+        p = ImageVise::Pipeline.new.crop(width: 10, height: 10, gravity: 'c')
+        image_request = ImageVise::ImageRequest.new(src_url: uri.to_s, pipeline: p)
+        params = image_request.to_query_string_params('l33tness')
+        
+        expect_any_instance_of(Patron::Session).to receive(:get_file) {|_self, url, path|
+          File.open(path, 'wb') {|f| f << 'totally not an image' }
+          double(status: 200)
+        }
+        expect(app).to receive(:handle_request_error).and_call_original
+        
+        get '/', params
+        expect(last_response.status).to eq(422)
+        expect(last_response['Cache-Control']).to eq("private, max-age=0, no-cache")
+        expect(last_response.body).to include('Unsupported/unknown')
+      end
+    end
+    
+    it 'responds with 403 when upstream returns it' do
+      uri = Addressable::URI.parse(public_url)
+      ImageVise.add_allowed_host!(uri.host)
+      ImageVise.add_secret_key!('l33tness')
+      uri.path = '/forbidden'
+
+      p = ImageVise::Pipeline.new.crop(width: 10, height: 10, gravity: 'c')
+      image_request = ImageVise::ImageRequest.new(src_url: uri.to_s, pipeline: p)
+      params = image_request.to_query_string_params('l33tness')
+
+      get '/', params
+      expect(last_response.status).to eq(403)
+      expect(last_response.headers['Content-Type']).to eq('application/json')
+      parsed = JSON.load(last_response.body)
+      expect(parsed['errors']).to include("Unfortunate upstream response: 403")
+    end
+    
+    it 'replays upstream error response codes that are selected to be replayed to the requester' do
+      uri = Addressable::URI.parse(public_url)
+      ImageVise.add_allowed_host!(uri.host)
+      ImageVise.add_secret_key!('l33tness')
+      
+      [404, 403, 503, 504, 500].each do | error_code |
+        allow_any_instance_of(Patron::Session).to receive(:get_file).and_return(double(status: error_code))
+        
+        p = ImageVise::Pipeline.new.crop(width: 10, height: 10, gravity: 'c')
+        image_request = ImageVise::ImageRequest.new(src_url: uri.to_s, pipeline: p)
+        params = image_request.to_query_string_params('l33tness')
+        
+        get '/', params
+        expect(last_response.status).to eq(error_code)
+        expect(last_response.headers).to have_key('Cache-Control')
+        expect(last_response.headers['Cache-Control']).to eq("private, max-age=0, no-cache")
+        
+        expect(last_response.headers['Content-Type']).to eq('application/json')
+        parsed = JSON.load(last_response.body)
+        expect(parsed['errors']).to include("Unfortunate upstream response: #{error_code}")
+      end
+    end
+    
+    it 'sets very far caching headers and an ETag, and returns a 304 if any ETag is set' do
+      uri = Addressable::URI.parse(public_url)
+      ImageVise.add_allowed_host!(uri.host)
+      ImageVise.add_secret_key!('l33tness')
+      
+      p = ImageVise::Pipeline.new.fit_crop(width: 10, height: 35, gravity: 'c')
+      image_request = ImageVise::ImageRequest.new(src_url: uri.to_s, pipeline: p)
+      params = image_request.to_query_string_params('l33tness')
+      
+      get '/', params
+      
+      expect(last_response).to be_ok
+      expect(last_response['ETag']).not_to be_nil
+      expect(last_response['Cache-Control']).to eq('public')
+      
+      get '/', params, {'HTTP_IF_NONE_MATCH' => last_response['ETag']}
+      expect(last_response.status).to eq(304)
+      
+      # Should consider _any_ ETag a request to rerender something
+      # that already exists in an upstream cache
+      get '/', params, {'HTTP_IF_NONE_MATCH' => SecureRandom.hex(4)}
+      expect(last_response.status).to eq(304)
+    end
+    
+    it 'when all goes well responds with an image that passes through all the processing steps' do
+      uri = Addressable::URI.parse(public_url)
+      ImageVise.add_allowed_host!(uri.host)
+      ImageVise.add_secret_key!('l33tness')
+
+      p = ImageVise::Pipeline.new.geom(geometry_string: '512x335').fit_crop(width: 10, height: 10, gravity: 'c')
+      image_request = ImageVise::ImageRequest.new(src_url: uri.to_s, pipeline: p)
+      params = image_request.to_query_string_params('l33tness')
+
+      get '/', params
+      expect(last_response.status).to eq(200)
+
+      expect(last_response.headers['Content-Type']).to eq('image/jpeg')
+      expect(last_response.headers).to have_key('Content-Length')
+      parsed_image = Magick::Image.from_blob(last_response.body)[0]
+      expect(parsed_image.columns).to eq(10)
+    end
+    
+    it 'returns the processed JPEG image as a PNG if it had to get an alpha channel during processing' do
+      uri = Addressable::URI.parse(public_url)
+      ImageVise.add_allowed_host!(uri.host)
+      ImageVise.add_secret_key!('l33tness')
+
+      p = ImageVise::Pipeline.new.geom(geometry_string: '220x220').ellipse_stencil
+      image_request = ImageVise::ImageRequest.new(src_url: uri.to_s, pipeline: p)
+      params = image_request.to_query_string_params('l33tness')
+
+      get '/', params
+      expect(last_response.status).to eq(200)
+
+      expect(last_response.headers['Content-Type']).to eq('image/png')
+      expect(last_response.headers).to have_key('Content-Length')
+
+      examine_image_from_string(last_response.body)
+    end
+  end
+end

data/spec/image_vise/sharpen_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe ImageVise::Sharpen do
+  it 'refuses invalid parameters' do
+    expect { described_class.new(sigma: 0, radius: -1) }.to raise_error(ArgumentError)
+  end
+  
+  it 'applies the crop with different gravities' do
+    [[1, 1], [4, 2], [0.75, 0.5]].each do |(r, s)|
+      image = Magick::Image.read(test_image_path)[0]
+      expect(ImageVise).to receive(:destroy).with(instance_of(Magick::Image)).and_call_original
+      sharpen = described_class.new(radius: r, sigma: s)
+      sharpen.apply!(image)
+      examine_image(image, "sharpen-rad_%02f-sigma_%02f" % [r, s])
+    end
+  end
+end

data/spec/image_vise_spec.rb

@@ -0,0 +1,89 @@
+require_relative 'spec_helper'
+require 'rack/test'
+
+describe ImageVise do
+  include Rack::Test::Methods
+  
+  def app
+    described_class.new
+  end
+  
+  context 'ImageVise.allowed_hosts' do
+    xit 'returns the allowed hosts' do
+      expect(described_class.allowed_hosts).not_to be_empty
+      expect(described_class.allowed_hosts).to include('wetransfer-unittests.s3.amazonaws.com')
+    end
+    
+    it 'allows add_allowed_host! and reset_allowed_hosts!' do
+      described_class.add_allowed_host!('www.imageboard.im')
+      expect(described_class.allowed_hosts).to include('www.imageboard.im')
+      described_class.reset_allowed_hosts!
+      expect(described_class.allowed_hosts).not_to include('www.imageboard.im')
+    end
+  end
+  
+  context 'ImageVise.secret_keys' do
+    it 'raises when asked for a key and no keys has been set' do
+      expect {
+        described_class.secret_keys
+      }.to raise_error("No keys set, add a key using `ImageVise.add_secret_key!(key)'")
+    end
+    
+    it 'allows add_secret_key!(key) and reset_secret_keys!' do
+      described_class.add_secret_key!('l33t')
+      expect(described_class.secret_keys).to include('l33t')
+      described_class.reset_secret_keys!
+      expect {
+        expect(described_class.secret_keys)
+      }.to raise_error
+    end
+  end
+
+  describe 'ImageVise.new.call' do
+    it 'instantiates a new app and performs call() on it' do
+      expect_any_instance_of(ImageVise::RenderEngine).to receive(:call).with(:mock_env) { :yes }
+      ImageVise.new.call(:mock_env)
+    end
+  end
+
+  describe 'ImageVise.call' do
+    it 'instantiates a new app and performs call() on it' do
+      expect_any_instance_of(ImageVise::RenderEngine).to receive(:call).with(:mock_env) { :yes }
+      ImageVise.call(:mock_env)
+    end
+  end
+  
+  describe '.image_params' do
+    it 'generates a Hash with paremeters for processing the resized image' do
+      params = ImageVise.image_params(src_url: 'http://host.com/image.jpg', secret: 'l33t') do |pipe|
+        pipe.fit_crop width: 128, height: 256, gravity: 'c'
+      end
+      expect(params).to be_kind_of(Hash)
+      expect(params[:q]).not_to be_empty
+      expect(params[:sig]).not_to be_empty
+    end
+  end
+  
+  describe 'methods dealing with the operator list' do
+    it 'have the basic operators already set up' do
+      oplist = ImageVise.defined_operator_names
+      expect(oplist).to include('sharpen')
+      expect(oplist).to include('crop')
+    end
+    
+    it 'allows an operator to be added and retrieved' do
+      class CustomOp; end
+      ImageVise.add_operator 'custom_op', CustomOp
+      expect(ImageVise.operator_from(:custom_op)).to eq(CustomOp)
+      expect(ImageVise.operator_name_for(CustomOp.new)).to eq('custom_op')
+      expect(ImageVise.defined_operator_names).to include('custom_op')
+    end
+    
+    it 'raises an exception when an operator key is requested that does not exist' do
+      class UnknownOp; end
+      expect {
+        ImageVise.operator_name_for(UnknownOp.new)
+      }.to raise_error(/not registered using ImageVise/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,74 @@
+require 'bundler'
+Bundler.require
+
+require 'addressable/uri'
+require 'strenv'
+require 'tmpdir'
+require_relative 'test_server'
+
+
+TEST_RENDERS_DIR = Dir.mktmpdir
+
+module Examine
+  def examine_image(magick_image, name_tag = 'test-img')
+    # When doing TDD, waiting for stuff to open is a drag - allow
+    # it to be squelched using 2 envvars. Also viewing images
+    # makes no sense on CI unless we bother with artifacts.
+    # The first one is what Gitlab-CI sets for us.
+    return if ENV.key?("CI_BUILD_ID")
+    return if ENV.key?("SKIP_INTERACTIVE")
+    
+    Dir.mkdir(TEST_RENDERS_DIR) unless File.exist?(TEST_RENDERS_DIR)
+    path = File.join(TEST_RENDERS_DIR, name_tag + '.png')
+    magick_image.format = 'png'
+    magick_image.write(path)
+    `open #{path}`
+  end
+  
+  def examine_image_from_string(string)
+    # When doing TDD, waiting for stuff to open is a drag - allow
+    # it to be squelched using 2 envvars. Also viewing images
+    # makes no sense on CI unless we bother with artifacts.
+    # The first one is what Gitlab-CI sets for us.
+    return if ENV.key?("CI_BUILD_ID")
+    return if ENV.key?("SKIP_INTERACTIVE")
+    
+    Dir.mkdir(TEST_RENDERS_DIR) unless File.exist?(TEST_RENDERS_DIR)
+    random_name = 'test-image-%s' % SecureRandom.hex(3)
+    path = File.join(TEST_RENDERS_DIR, random_name)
+    File.open(path, 'wb'){|f| f << string }
+    `open #{path}`
+  end
+end
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require_relative '../lib/image_vise'
+
+RSpec.configure do | config |
+  config.order = 'random'
+  config.include Examine
+  config.before :suite do
+    TestServer.start(nil, ssl=false, port=9001)
+  end
+
+  config.after :suite do
+    sleep 2
+    FileUtils.rm_rf(TEST_RENDERS_DIR)
+  end
+
+  def test_image_path
+    File.expand_path(__dir__ + '/waterside_magic_hour.jpg')
+  end
+
+  def public_url
+    'http://localhost:9001/waterside_magic_hour.jpg'
+  end
+
+  config.around :each do |e|
+    STRICT_ENV.with_protected_env { e.run }
+  end
+end

data/spec/test_server.rb

@@ -0,0 +1,61 @@
+require 'webrick'
+include WEBrick
+
+class ForbiddenServlet < HTTPServlet::AbstractServlet
+  def do_GET(req,res)
+    res['Content-Type'] = "text/plain"
+    res.status = 403
+  end
+end
+
+class TestServer
+  def self.start( log_file = nil, ssl = false, port = 9001 )
+    new(log_file, ssl, port).start
+  end
+
+  def initialize( log_file = nil, ssl = false, port = 9001 )
+    log_file ||= StringIO.new
+    log = WEBrick::Log.new(log_file)
+
+    options = {
+      :Port => port,
+      :Logger => log,
+      :AccessLog => [
+          [ log, WEBrick::AccessLog::COMMON_LOG_FORMAT ],
+          [ log, WEBrick::AccessLog::REFERER_LOG_FORMAT ]
+       ],
+       :DocumentRoot => File.expand_path(__dir__),
+    }
+
+    if ssl
+      options[:SSLEnable] = true
+      options[:SSLCertificate] = OpenSSL::X509::Certificate.new(File.open("spec/certs/cacert.pem").read)
+      options[:SSLPrivateKey] = OpenSSL::PKey::RSA.new(File.open("spec/certs/privkey.pem").read)
+      options[:SSLCertName] = [ ["CN", WEBrick::Utils::getservername ] ]
+    end
+
+    @server = WEBrick::HTTPServer.new(options)
+    @server.mount("/forbidden", ForbiddenServlet)
+  end
+
+  def start
+    trap('INT') {
+      begin
+        @server.shutdown unless @server.nil?
+      rescue Object => e
+        $stderr.puts "Error #{__FILE__}:#{__LINE__}\n#{e.message}"
+      end
+    }
+
+    @thread = Thread.new { @server.start }
+    Thread.pass
+    self
+  end
+
+  def join
+    if defined? @thread and @thread
+      @thread.join
+    end
+    self
+  end
+end