image_vise 0.1.6 → 0.2.0

data/lib/image_vise/writers/auto_writer.rb

@@ -0,0 +1,23 @@
+# Picks the most reasonable "default" output format for web resources. In practice, if the
+# image contains transparency (an alpha channel) PNG will be chosen, and if not - JPEG will
+# be chosen. Since ImageVise URLs do not contain a file extension we are free to pick
+# the suitable format at render time
+class ImageVise::AutoWriter
+  # The default file type for images with alpha
+  PNG_FILE_TYPE = MagicBytes::FileType.new('png','image/png').freeze
+
+  # Renders the file as a jpg if the custom output filetype operator is used
+  JPG_FILE_TYPE = MagicBytes::FileType.new('jpg','image/jpeg').freeze
+  
+  def write_image!(magick_image, _, render_to_path)
+    # If processing the image has created an alpha channel, use PNG always.
+    # Otherwise, keep the original format for as far as the supported formats list goes.
+    render_file_type = if magick_image.alpha?
+      PNG_FILE_TYPE
+    else
+      JPG_FILE_TYPE
+    end
+    magick_image.format = render_file_type.ext
+    magick_image.write(render_to_path)
+  end
+end

data/lib/image_vise/writers/jpeg_writer.rb

@@ -0,0 +1,9 @@
+class ImageVise::JPGWriter < Ks.strict(:quality)
+  JPG_FILE_TYPE = MagicBytes::FileType.new('jpg','image/jpeg').freeze
+
+  def write_image!(magick_image, _, render_to_path)
+    q = self.quality  # to avoid the changing "self" context
+    magick_image.format = JPG_FILE_TYPE.ext
+    magick_image.write(render_to_path) { self.quality = q }
+  end
+end

data/lib/image_vise.rb

@@ -8,37 +8,37 @@ require 'base64'
 require 'rack'
 
 class ImageVise
-  VERSION = '0.1.6'
+  require_relative 'image_vise/version'
   S_MUTEX = Mutex.new
   private_constant :S_MUTEX
-  
+
   @allowed_hosts = Set.new
   @keys = Set.new
   @operators = {}
   @allowed_glob_patterns = Set.new
   @fetchers = {}
-  
+
   class << self
     # Resets all allowed hosts
     def reset_allowed_hosts!
       S_MUTEX.synchronize { @allowed_hosts.clear }
     end
-    
+
     # Add an allowed host
     def add_allowed_host!(hostname)
       S_MUTEX.synchronize { @allowed_hosts << hostname }
     end
-    
+
     # Returns both the allowed hosts added at runtime and the ones set in the constant
     def allowed_hosts
       S_MUTEX.synchronize { @allowed_hosts.to_a }
     end
-    
+
     # Removes all set keys
     def reset_secret_keys!
       S_MUTEX.synchronize { @keys.clear }
     end
-    
+
     def allow_filesystem_source!(glob_pattern)
       S_MUTEX.synchronize { @allowed_glob_patterns << glob_pattern }
     end
@@ -52,24 +52,24 @@ class ImageVise
     end
 
     # Adds a key against which the parameters are going to be verified.
-    # Multiple applications may have their own different keys, 
+    # Multiple applications may have their own different keys,
     # so we need to have multiple keys.
     def add_secret_key!(key)
       S_MUTEX.synchronize { @keys << key }
       self
     end
-    
+
     # Returns the array of defined keys or raises an exception if no keys have been set yet
     def secret_keys
       keys = S_MUTEX.synchronize { @keys.any? && @keys.to_a }
       keys or raise "No keys set, add a key using `ImageVise.add_secret_key!(key)'"
     end
-    
+
     # Generate a set of querystring params for a resized image. Yields a Pipeline object that
     # will receive method calls for adding image operations to a stack.
     #
     #   ImageVise.image_params(src_url: image_url_on_s3, secret: '...') do |p|
-    #      p.center_fit width: 128, height: 128 
+    #      p.center_fit width: 128, height: 128
     #      p.elliptic_stencil
     #   end #=> {q: '...', sig: '...'}
     #
@@ -88,7 +88,7 @@ class ImageVise
     # will receive method calls for adding image operations to a stack.
     #
     #   ImageVise.image_path(src_url: image_url_on_s3, secret: '...') do |p|
-    #      p.center_fit width: 128, height: 128 
+    #      p.center_fit width: 128, height: 128
     #      p.elliptic_stencil
     #   end #=> "/abcdef/xyz123"
     #
@@ -112,26 +112,26 @@ class ImageVise
     def operator_from(operator_name)
       @operators.fetch(operator_name.to_s)
     end
-    
+
     def defined_operator_names
       @operators.keys
     end
-    
+
     def register_fetcher(scheme, fetcher)
       S_MUTEX.synchronize { @fetchers[scheme.to_s] = fetcher }
     end
-    
+
     def fetcher_for(scheme)
       S_MUTEX.synchronize { @fetchers[scheme.to_s] or raise "No fetcher registered for #{scheme}" }
     end
-    
+
     def operator_name_for(operator)
       S_MUTEX.synchronize do
         @operators.key(operator.class) or raise "Operator #{operator.inspect} not registered using ImageVise.add_operator"
       end
     end
   end
-  
+
   # Made available since the object that is used with `mount()` in Rails
   # has to, by itself, to respond to `call`.
   #
@@ -146,11 +146,11 @@ class ImageVise
   def self.call(rack_env)
     ImageVise::RenderEngine.new.call(rack_env)
   end
-  
+
   def call(rack_env)
     ImageVise::RenderEngine.new.call(rack_env)
   end
-  
+
   # Used as a shorthand to force-destroy Magick images in ensure() blocks. Since
   # ensure blocks sometimes deal with variables in inconsistent states (variable
   # in scope but not yet set to an image) we take the possibility of nils into account.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_vise
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: patron
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.15'
-- !ruby/object:Gem::Dependency
-  name: exceptional_fork
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: ks
   requirement: !ruby/object:Gem::Requirement
@@ -70,88 +56,60 @@ dependencies:
   name: magic_bytes
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: rack-cache
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: strenv
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,21 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: foreman
+  name: strenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,41 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10'
-- !ruby/object:Gem::Dependency
-  name: jeweler
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -255,13 +179,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Image processing via URLs
-email: me@julik.nl
+email:
+- me@julik.nl
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
 - DEVELOPMENT.md
 - Gemfile
 - LICENSE.txt
@@ -279,9 +204,11 @@ files:
 - lib/image_vise/file_response.rb
 - lib/image_vise/image_request.rb
 - lib/image_vise/operators/auto_orient.rb
+- lib/image_vise/operators/background_fill.rb
 - lib/image_vise/operators/crop.rb
 - lib/image_vise/operators/ellipse_stencil.rb
 - lib/image_vise/operators/fit_crop.rb
+- lib/image_vise/operators/force_jpg_out.rb
 - lib/image_vise/operators/geom.rb
 - lib/image_vise/operators/sRGB_v4_ICC_preference_displayclass.icc
 - lib/image_vise/operators/sharpen.rb
@@ -289,33 +216,14 @@ files:
 - lib/image_vise/operators/strip_metadata.rb
 - lib/image_vise/pipeline.rb
 - lib/image_vise/render_engine.rb
-- spec/image_vise/auto_orient_spec.rb
-- spec/image_vise/crop_spec.rb
-- spec/image_vise/ellipse_stencil_spec.rb
-- spec/image_vise/fetcher_file_spec.rb
-- spec/image_vise/fetcher_http_spec.rb
-- spec/image_vise/file_response_spec.rb
-- spec/image_vise/fit_crop_spec.rb
-- spec/image_vise/geom_spec.rb
-- spec/image_vise/image_request_spec.rb
-- spec/image_vise/pipeline_spec.rb
-- spec/image_vise/render_engine_spec.rb
-- spec/image_vise/sharpen_spec.rb
-- spec/image_vise/srgb_spec.rb
-- spec/image_vise/strip_metadata_spec.rb
-- spec/image_vise_spec.rb
-- spec/layers-with-blending.psd
-- spec/spec_helper.rb
-- spec/test_server.rb
-- spec/waterside_magic_hour.jpg
-- spec/waterside_magic_hour.psd
-- spec/waterside_magic_hour_adobergb.jpg
-- spec/waterside_magic_hour_gray.tif
-- spec/waterside_magic_hour_transp.png
+- lib/image_vise/version.rb
+- lib/image_vise/writers/auto_writer.rb
+- lib/image_vise/writers/jpeg_writer.rb
 homepage: https://github.com/WeTransfer/image_vise
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -332,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Runtime thumbnailing proxy

data/spec/image_vise/auto_orient_spec.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-
-describe ImageVise::AutoOrient do
-  it 'applies auto orient to the image' do
-    image = Magick::Image.read(test_image_path)[0]
-    orient = described_class.new
-    expect(image).to receive(:auto_orient!).and_call_original
-    orient.apply!(image)
-  end
-end

data/spec/image_vise/crop_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-
-describe ImageVise::Crop do
-  it 'refuses invalid parameters' do
-    expect { described_class.new(width: 0, height: -1, gravity: '') }.to raise_error(ArgumentError)
-  end
-  
-  it 'applies the crop with different gravities' do
-    %w( s sw se n ne nw c).each do |gravity|
-      image = Magick::Image.read(test_image_path)[0]
-      crop = described_class.new(width: 120, height: 220, gravity: gravity)
-
-      crop.apply!(image)
-
-      expect(image.columns).to eq(120)
-      expect(image.rows).to eq(220)
-      examine_image(image, "gravity-%s-" % gravity)
-    end
-  end
-end

data/spec/image_vise/ellipse_stencil_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-describe ImageVise::EllipseStencil do
-  it 'applies the circle stencil' do
-    image = Magick::Image.read(test_image_path)[0]
-    stencil = described_class.new
-    stencil.apply!(image)
-    examine_image(image, "circle-stencil")
-  end
-
-  it 'applies the circle stencil to a png with transparency' do
-    png_transparent_path = File.expand_path(__dir__ + '/../waterside_magic_hour_transp.png')
-    image = Magick::Image.read(png_transparent_path)[0]
-    stencil = described_class.new
-    stencil.apply!(image)
-    examine_image(image, "circle-stencil-transparent-bg")
-  end
-
-end

data/spec/image_vise/fetcher_file_spec.rb

@@ -1,48 +0,0 @@
-require_relative '../spec_helper'
-
-describe ImageVise::FetcherFile do
-  it 'is a class (can be inherited from)' do
-    expect(ImageVise::FetcherFile).to be_kind_of(Class)
-  end
-
-  it 'is registered as a fetcher for file://' do
-    expect(ImageVise.fetcher_for('file')).to eq(ImageVise::FetcherFile)
-  end
-  
-  it 'returns a Tempfile containing this test suite' do
-    path = File.expand_path(__FILE__)
-    ruby_files_in_this_directory = __dir__ + '/*.rb'
-    ImageVise.allow_filesystem_source! ruby_files_in_this_directory
-    
-    uri = URI('file://' + URI.encode(path))
-    fetched = ImageVise::FetcherFile.fetch_uri_to_tempfile(uri)
-
-    expect(fetched).to be_kind_of(Tempfile)
-    expect(fetched.size).to eq(File.size(__FILE__))
-    expect(fetched.pos).to be_zero
-  end
-
-  it 'raises a meaningful exception if no file sources are permitted' do
-    path = File.expand_path(__FILE__)
-
-    ImageVise.deny_filesystem_sources!
-
-    uri = URI('file://' + URI.encode(path))
-    expect {
-      ImageVise::FetcherFile.fetch_uri_to_tempfile(uri)
-    }.to raise_error(ImageVise::FetcherFile::AccessError)
-  end
-  
-  it 'raises a meaningful exception if this file is not permitted as source' do
-    path = File.expand_path(__FILE__)
-
-    text_files_in_this_directory = __dir__ + '/*.txt'
-    ImageVise.deny_filesystem_sources!
-    ImageVise.allow_filesystem_source! text_files_in_this_directory
-
-    uri = URI('file://' + URI.encode(path))
-    expect {
-      ImageVise::FetcherFile.fetch_uri_to_tempfile(uri)
-    }.to raise_error(ImageVise::FetcherFile::AccessError)
-  end
-end

data/spec/image_vise/fetcher_http_spec.rb

@@ -1,44 +0,0 @@
-require_relative '../spec_helper'
-
-describe ImageVise::FetcherHTTP do
-  it 'is a class (can be inherited from)' do
-    expect(ImageVise::FetcherHTTP).to be_kind_of(Class)
-  end
-
-  it 'is registered as a fetcher for http:// and https://' do
-    expect(ImageVise.fetcher_for('http')).to eq(ImageVise::FetcherHTTP)
-    expect(ImageVise.fetcher_for('https')).to eq(ImageVise::FetcherHTTP)
-  end
-
-  it 'raises an AccessError if the host of the URL is not on the whitelist' do
-    uri = URI('https://wrong-origin.com/image.psd')
-    expect {
-      ImageVise::FetcherHTTP.fetch_uri_to_tempfile(uri)
-    }.to raise_error(ImageVise::FetcherHTTP::AccessError, /is not permitted as source/)
-  end
-
-  it 'raises an UpstreamError if the upstream fetch returns an error-ish status code' do
-    uri = URI('http://localhost:9001/forbidden')
-    ImageVise.add_allowed_host! 'localhost'
-    
-    expect {
-      ImageVise::FetcherHTTP.fetch_uri_to_tempfile(uri)
-    }.to raise_error {|e|
-      expect(e).to be_kind_of(ImageVise::FetcherHTTP::UpstreamError)
-      expect(e.message).to include(uri.to_s)
-      expect(e.message).to include('403')
-      expect(e.http_status).to eq(403)
-    }
-  end
-
-  it 'fetches the image into a Tempfile' do
-    uri = URI(public_url_psd)
-    ImageVise.add_allowed_host! 'localhost'
-
-    result = ImageVise::FetcherHTTP.fetch_uri_to_tempfile(uri)
-
-    expect(result).to be_kind_of(Tempfile)
-    expect(result.size).to be_nonzero
-    expect(result.pos).to be_zero
-  end
-end

data/spec/image_vise/file_response_spec.rb

@@ -1,45 +0,0 @@
-require_relative '../spec_helper'
-
-describe ImageVise::FileResponse do
-  it 'reads the file in binary mode, closes and unlinks the tempfile when close() is called' do
-    random_data = SecureRandom.random_bytes(1024 * 2048)
-    f = Tempfile.new("experiment")
-    f.binmode
-    f << random_data
-    
-    response = described_class.new(f)
-    readback = ''.encode(Encoding::BINARY)
-    response.each do | chunk |
-      expect(chunk.encoding).to eq(Encoding::BINARY)
-      readback << chunk
-    end
-    
-    response.close
-    
-    expect(readback).to eq(random_data)
-    expect(f).to be_closed
-    expect(f.path).to be_nil
-  end
-  
-  it 'only asks for the path of the tempfile and uses a separate file descriptor' do
-    f = Tempfile.new("experiment")
-    f.binmode
-    f << SecureRandom.random_bytes(2048)
-    f.flush
-    
-    # Use a double so that all the methods except the ones we mock raise an assertion
-    double = double(path: f.path)
-    expect(double).to receive(:flush)
-    
-    read_from_response = ''.encode(Encoding::BINARY)
-    response = described_class.new(double)
-    response.each{|b| read_from_response << b }
-    
-    f.rewind
-    
-    expect(f.read).to eq(read_from_response)
-    
-    f.close
-    f.unlink
-  end
-end

data/spec/image_vise/fit_crop_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-
-describe ImageVise::FitCrop do
-  it 'refuses invalid arguments' do
-    expect { described_class.new(width: 0, height: -1, gravity: '') }.to raise_error(ArgumentError)
-  end
-  
-  it 'applies the crop with different gravities' do
-    %w( s sw se n ne nw c).each do |gravity|
-      image = Magick::Image.read(test_image_path)[0]
-      crop = described_class.new(width: 120, height: 220, gravity: gravity)
-
-      crop.apply!(image)
-
-      expect(image.columns).to eq(120)
-      expect(image.rows).to eq(220)
-      examine_image(image, "gravity-%s-" % gravity)
-    end
-  end
-end