image_vise 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bb222a8353542a7b5224ab75dc03df4b453e2b7
-  data.tar.gz: 94c346a22cd2a34b80eaefe97f05e50a8fe944f7
+  metadata.gz: 6a71e26e83e715290293b8e512fe6f72aaa39098
+  data.tar.gz: 4dd57c319fe8728e0bc8cf0e2fdd67ab41bc028b
 SHA512:
-  metadata.gz: cdad17d7b3d12eb171158a50566b0abccab8a48aa48c28716e25e20741cdc15e369f5035793f53a0d0ce5ec405ad0b86013721b8f251bcfad3952a5ea1698e66
-  data.tar.gz: 3d8cc40c202b112de3ed0b4a1462fbfbba0ba08051ba3ab51a6db894c5e146985a3785ada873b96182de63f1f46f90f3be2e44eee7472b79a8250aaefbf3fb5c
+  metadata.gz: 8c53127c2ef018e94200a23281d6923497d5466d19ae63b8d18ad0a292f3eb6e6615baccee577d01cee774e50b32fa04e6c5e910d2e9a9cd445fc47f5bfb814f
+  data.tar.gz: f0fbe07c4fb401161714862fff8833300821d51f710140a0f16f6336251243ae48679a4ff5ac9df48970baaed97c4ba4080e0562fcb4c5cf7dbe3b6be437cbc9

data/README.md

@@ -208,6 +208,7 @@ The gem version is specified in `image_vise.rb`. When contributing, please follo
 
 Copyright (c) 2016 WeTransfer. See LICENSE.txt for further details.
 The licensing terms also apply to the `waterside_magic_hour.jpg` test image.
+The `worker_in_tube.jpg` is used with permission from Arcadis Nederland B.V.
 
 The sRGB color profiles are [downloaded from the ICC](http://www.color.org/srgbprofiles.xalter) and it's
 use is governed by the terms present in the LICENSE.txt

data/image_vise.gemspec

@@ -40,4 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "addressable"
   spec.add_development_dependency "strenv"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry"
 end

data/lib/image_vise.rb

@@ -11,12 +11,15 @@ class ImageVise
   require_relative 'image_vise/version'
   S_MUTEX = Mutex.new
   private_constant :S_MUTEX
+  # The default cache liftime is 30 days, and will be used if no custom lifetime is set.
+  DEFAULT_CACHE_LIFETIME = 2_592_000
 
   @allowed_hosts = Set.new
   @keys = Set.new
   @operators = {}
   @allowed_glob_patterns = Set.new
   @fetchers = {}
+  @cache_lifetime = DEFAULT_CACHE_LIFETIME
 
   class << self
     # Resets all allowed hosts
@@ -51,6 +54,21 @@ class ImageVise
       S_MUTEX.synchronize { @allowed_glob_patterns.clear }
     end
 
+    def cache_lifetime_seconds=(length)
+      Integer(length)
+      S_MUTEX.synchronize { @cache_lifetime = length.to_i }
+    rescue => e
+      raise ArgumentError, "The custom cache lifetime value must be an integer"
+    end
+
+    def cache_lifetime_seconds
+      S_MUTEX.synchronize { @cache_lifetime }
+    end
+
+    def reset_cache_lifetime_seconds!
+      S_MUTEX.synchronize { @cache_lifetime = DEFAULT_CACHE_LIFETIME }
+    end
+
     # Adds a key against which the parameters are going to be verified.
     # Multiple applications may have their own different keys,
     # so we need to have multiple keys.

data/lib/image_vise/operators/srgb.rb

@@ -25,6 +25,9 @@ class ImageVise::SRGB
   PROFILE_PATH = File.expand_path(__dir__ + '/sRGB_v4_ICC_preference_displayclass.icc')
   def apply!(magick_image)
     magick_image.add_profile(PROFILE_PATH)
+  rescue Magick::ImageMagickError
+    magick_image.strip!
+    magick_image.add_profile(PROFILE_PATH)
   end
   ImageVise.add_operator 'srgb', self
 end

data/lib/image_vise/render_engine.rb

@@ -20,13 +20,13 @@
     'Cache-Control' => 'public, max-age=5'
   }).freeze
 
-  # "public" of course. Add max-age so that there is _some_
+  # Cache details:  "public" of course. Add max-age so that there is _some_
   # revalidation after a time (otherwise some proxies treat it
   # as "must-revalidate" always), and "no-transform" so that
   # various deflate schemes are not applied to it (does happen
   # with Rack::Cache and leads Chrome to throw up on content
   # decoding for example).
-  IMAGE_CACHE_CONTROL = 'public, no-transform, max-age=2592000'
+  IMAGE_CACHE_CONTROL = "public, no-transform, max-age=%d"
 
   # How long is a render (the ImageMagick/write part) is allowed to
   # take before we kill it
@@ -166,7 +166,8 @@
   # `process_image_request` unsplatted, and returns a triplet that
   # can be returned as a Rack response. The Rack response will contain
   # an iterable body object that is designed to automatically delete
-  # the Tempfile it wraps on close.
+  # the Tempfile it wraps on close. Sets the cache lifetime to either the default
+  # value of 2592000 or the value the user selected using add_custom_cache_max_length.
   #
   # @param render_destination_file[File] the File handle to the rendered image
   # @param render_file_type[MagicBytes::FileType] the rendered file type
@@ -175,7 +176,7 @@
     response_headers = DEFAULT_HEADERS.merge({
       'Content-Type' => render_file_type.mime,
       'Content-Length' => '%d' % render_destination_file.size,
-      'Cache-Control' => IMAGE_CACHE_CONTROL,
+      'Cache-Control' => IMAGE_CACHE_CONTROL % ImageVise.cache_lifetime_seconds,
       'ETag' => etag
     })
 

data/lib/image_vise/version.rb

@@ -1,3 +1,3 @@
 class ImageVise
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/spec/image_vise/render_engine_spec.rb

@@ -37,6 +37,7 @@ describe ImageVise::RenderEngine do
     after :each do
       ImageVise.reset_allowed_hosts!
       ImageVise.reset_secret_keys!
+      ImageVise.reset_cache_lifetime_seconds!
     end
 
     it 'halts with 400 when the requested image cannot be opened by ImageMagick' do
@@ -137,6 +138,37 @@ describe ImageVise::RenderEngine do
       expect(last_response.status).to eq(304)
     end
 
+    it 'allows for setting a custom cache lifetime' do
+      uri = Addressable::URI.parse(public_url)
+      ImageVise.add_allowed_host!(uri.host)
+      ImageVise.add_secret_key!('l33tness')
+
+      ImageVise.cache_lifetime_seconds = '900'
+      p = ImageVise::Pipeline.new.fit_crop(width: 10, height: 35, gravity: 'c')
+      image_request = ImageVise::ImageRequest.new(src_url: uri.to_s, pipeline: p)
+
+      req_path = image_request.to_path_params('l33tness')
+
+      get req_path, {}
+      expect(last_response).to be_ok
+      expect(last_response['Cache-Control']).to match(/max-age=900/)
+    end
+
+    it 'uses the correct default cache lifetime if one is not specified' 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)
+
+      req_path = image_request.to_path_params('l33tness')
+
+      get req_path, {}
+      expect(last_response).to be_ok
+      expect(last_response['Cache-Control']).to match(/max-age=2592000/)
+    end
+
     it 'responds with an image that passes through all the processing steps' do
       uri = Addressable::URI.parse(public_url)
       ImageVise.add_allowed_host!(uri.host)

data/spec/image_vise/srgb_spec.rb

@@ -20,4 +20,17 @@ describe ImageVise::SRGB do
     image.strip!
     examine_image(image, "from-srgb-SHOULD-LOOK-IDENTICAL")
   end
+
+  it 'applies the profile for an image with non-matching colorspace and profile' do
+    image = Magick::Image.read(test_image_mismatched_colorspace_profile_path).first
+    examine_image(image, 'pre-mismatched-colors')
+    described_class.new.apply!(image)
+    examine_image(image, 'post-mismatched-colors')
+  end
+
+  it "strips the image's profile if the profile and colorspace are non-matching" do
+    non_matching_image = Magick::Image.read(test_image_mismatched_colorspace_profile_path).first
+    expect(non_matching_image).to receive(:strip!).and_call_original
+    described_class.new.apply!(non_matching_image)
+  end
 end

data/spec/image_vise_spec.rb

@@ -3,16 +3,16 @@ require 'rack/test'
 
 describe ImageVise do
   include Rack::Test::Methods
-  
+
   def app
     described_class.new
   end
-  
+
   context 'ImageVise.allowed_hosts' do
     it 'returns the allowed hosts and is empty by default' do
       expect(described_class.allowed_hosts).to be_empty
     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')
@@ -20,14 +20,14 @@ describe ImageVise do
       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')
@@ -38,6 +38,34 @@ describe ImageVise do
     end
   end
 
+  context 'ImageVise.cache_lifetime_seconds=' do
+    it 'raises when given something other than an integer' do
+      expect {
+        described_class.cache_lifetime_seconds = "Wh0ops!"
+      }.to raise_error("The custom cache lifetime value must be an integer")
+    end
+
+    it 'succeeds when given an integer' do
+      expect {
+        described_class.cache_lifetime_seconds=(900)
+      }.not_to raise_error
+    end
+  end
+
+  context 'ImageVise.cache_lifetime_seconds' do
+    it 'allows cache_lifetime_seconds to be set' do
+      described_class.cache_lifetime_seconds = 100
+      expect(described_class.cache_lifetime_seconds).to eq(100)
+    end
+
+    it 'allows reset_cache_lifetime_seconds!' do
+      described_class.cache_lifetime_seconds = 100
+      expect(described_class.cache_lifetime_seconds).to eq(100)
+      described_class.reset_cache_lifetime_seconds!
+      expect(described_class.cache_lifetime_seconds).to eq(2592000)
+    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 }
@@ -51,7 +79,7 @@ describe ImageVise do
       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|
@@ -69,7 +97,7 @@ describe ImageVise do
       expect(http).to respond_to(:fetch_uri_to_tempfile)
       file = ImageVise.fetcher_for('file')
       expect(http).to respond_to(:fetch_uri_to_tempfile)
-      
+
       expect {
         ImageVise.fetcher_for('undernet')
       }.to raise_error(/No fetcher registered/)
@@ -84,14 +112,14 @@ describe ImageVise do
       expect(path).to start_with('/')
     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
@@ -99,7 +127,7 @@ describe ImageVise do
       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 {

data/spec/spec_helper.rb

@@ -8,9 +8,9 @@ Bundler.require
 
 require 'tmpdir'
 require 'securerandom'
-
 require 'addressable/uri'
 require 'strenv'
+require 'pry'
 require_relative 'test_server'
 
 TEST_RENDERS_DIR = Dir.mktmpdir
@@ -82,6 +82,10 @@ RSpec.configure do | config |
     File.expand_path(__dir__ + '/waterside_magic_hour_adobergb.jpg')
   end
 
+  def test_image_mismatched_colorspace_profile_path
+    File.expand_path(__dir__ + '/worker_in_tube.jpg')
+  end
+
   def test_image_png_transparency
     File.expand_path(__dir__ + '/waterside_magic_hour_transp.png')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_vise
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-17 00:00:00.000000000 Z
+date: 2017-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: patron
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 description: Image processing via URLs
 email:
 - me@julik.nl
@@ -246,6 +260,7 @@ files:
 - spec/waterside_magic_hour_adobergb.jpg
 - spec/waterside_magic_hour_gray.tif
 - spec/waterside_magic_hour_transp.png
+- spec/worker_in_tube.jpg
 homepage: https://github.com/WeTransfer/image_vise
 licenses:
 - MIT
@@ -267,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Runtime thumbnailing proxy